Skip to content

Commit 46c7cdd

Browse files
Add how-to and troubleshooting folder
1 parent 55d8d4f commit 46c7cdd

20 files changed

+36
-10
lines changed

docs/guides/index.rst renamed to docs/guides/how-to/index.rst

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,9 @@ whether that is Sphinx or MkDocs.
1818
adding-custom-css
1919
custom-404-page
2020
manage-translations
21-
mkdocs-old-versions
22-
pdf-non-ascii-languages
2321
remove-edit-buttons
2422
vcs
2523

26-
2724
Read the Docs how-to guides
2825
---------------------------
2926

@@ -33,13 +30,8 @@ These guides will help you customize or tune aspects of the Read the Docs build
3330
:maxdepth: 1
3431

3532
build-notifications
36-
build-using-too-many-resources
3733
technical-docs-seo-guide
38-
canonical
39-
conda
40-
environment-variables
41-
feature-flags
42-
google-analytics
43-
sitemaps
4434
specifying-dependencies
4535
wipe-environment
36+
google-analytics
37+
sitemaps
File renamed without changes.
File renamed without changes.

docs/guides/troubleshooting/index.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Troubleshooting Guides
2+
======================
3+
4+
These guides will help walk you through troubleshooting steps
5+
related to Read the Docs itself, documentation tools like Sphinx and MkDocs
6+
and how to write successful documentation.
7+
8+
9+
Sphinx & MkDocs troubleshooting guides
10+
--------------------------------------
11+
12+
These are the troubleshooting guides for your documentation authoring tool
13+
whether that is Sphinx or MkDocs.
14+
15+
.. toctree::
16+
:maxdepth: 1
17+
18+
mkdocs-old-versions
19+
pdf-non-ascii-languages
20+
remove-edit-buttons
21+
22+
23+
Read the Docs troubleshooting guides
24+
-------------------------------------
25+
26+
These troubleshooting guides are for the Read the Docs build environment.
27+
28+
.. toctree::
29+
:maxdepth: 1
30+
31+
canonical
32+
conda
33+
environment-variables
34+
specifying-dependencies
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)