-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Promote and restructure guides #8528
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
49ffef9
a84eb3c
037a15b
d0bd8d3
34ae50b
fb0de8f
b930940
d9c8752
a34972f
845ed86
30b7ce2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -50,7 +50,7 @@ see :ref:`faq:My documentation requires additional dependencies`. | |
Read the Docs offers some settings which can be used for a variety of purposes. | ||
To enable these settings, | ||
please send an email to [email protected] and we will change the settings for the project. | ||
Read more about these settings :doc:`here <guides/feature-flags>`. | ||
Read more about these settings :doc:`here <feature-flags>`. | ||
|
||
|
||
I get import errors on libraries that depend on C modules | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Guides for project administrators | ||
--------------------------------- | ||
|
||
These guides cover common use cases | ||
relevant for managing documentation projects, | ||
using the Read the Docs web interface | ||
astrojuanlu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
and making changes to the configuration files. | ||
|
||
For an introduction to Read the Docs, | ||
have a look at our :doc:`/tutorial/index`. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
technical-docs-seo-guide | ||
manage-translations | ||
searching-with-readthedocs | ||
hiding-a-version | ||
deprecating-content | ||
pdf-non-ascii-languages | ||
importing-private-repositories | ||
wipe-environment |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Guides for documentation authors | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a much better way to think about the guide structure 💯 |
||
-------------------------------- | ||
|
||
These guides offer some tips and tricks to author documentation | ||
with the tools supported on Read the Docs. | ||
Only reStructuredText or Markdown knowledge | ||
and minimal configuration tweaking are needed. | ||
|
||
For an introduction to Sphinx and Mkdocs, | ||
have a look at our :doc:`/intro/getting-started-with-sphinx` | ||
and :doc:`/intro/getting-started-with-mkdocs`. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
cross-referencing-with-sphinx | ||
intersphinx | ||
jupyter |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Guides for developers and designers | ||
----------------------------------- | ||
|
||
These guides are helpful for developers and designers | ||
seeking to extend the authoring tools | ||
or customize the documentation appearance. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
private-python-packages | ||
private-submodules | ||
adding-custom-css | ||
reproducible-builds | ||
embedding-content | ||
conda | ||
remove-edit-buttons | ||
build-using-too-many-resources | ||
vcs |
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -77,12 +77,15 @@ and some of the core features of Read the Docs. | |
* **Overview of core features**: | ||
:doc:`Incoming webhooks </webhooks>` | | ||
:doc:`/custom_domains` | | ||
:doc:`/canonical` | | ||
astrojuanlu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
:doc:`/versions` | | ||
:doc:`/downloadable-documentation` | | ||
:doc:`/hosting` | | ||
:doc:`/server-side-search` | | ||
:doc:`/analytics` | ||
:doc:`/pull-requests` | ||
:doc:`/analytics` | | ||
:doc:`/google-analytics` | | ||
astrojuanlu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
:doc:`/pull-requests` | | ||
:doc:`/build-notifications` | ||
ericholscher marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* **Connecting with GitHub, BitBucket, or GitLab**: | ||
:doc:`Connecting your VCS account </connected-accounts>` | | ||
|
@@ -106,12 +109,15 @@ and some of the core features of Read the Docs. | |
/config-file/index | ||
/webhooks | ||
/custom_domains | ||
/canonical | ||
astrojuanlu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
/versions | ||
/downloadable-documentation | ||
/hosting | ||
/server-side-search | ||
/analytics | ||
/google-analytics | ||
/pull-requests | ||
/build-notifications | ||
|
||
/connected-accounts | ||
|
||
|
@@ -123,25 +129,42 @@ and some of the core features of Read the Docs. | |
/faq | ||
|
||
|
||
Step-by-step Guides | ||
------------------- | ||
How-to Guides | ||
------------- | ||
|
||
These guides will help walk you through specific use cases | ||
related to Read the Docs itself, documentation tools like Sphinx and MkDocs | ||
and how to write successful documentation. | ||
|
||
* :doc:`/guides/tools` | ||
* :doc:`/guides/platform` | ||
* :doc:`/guides/commercial` | ||
* **For documentation authors**: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This shows we need more of these guides 🤔 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Double yes: we need more guides, and some of the current ones should probably be moved to Sphinx... |
||
:doc:`/guides/cross-referencing-with-sphinx` | | ||
:doc:`/guides/intersphinx` | | ||
:doc:`/guides/jupyter` | | ||
:doc:`Other guides for authors </guides/authors>` | ||
astrojuanlu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* **For project administrators**: | ||
:doc:`/guides/technical-docs-seo-guide` | | ||
:doc:`/guides/manage-translations` | | ||
:doc:`/guides/searching-with-readthedocs` | | ||
:doc:`/guides/private-submodules` | | ||
:doc:`Other guides for administrators </guides/administrators>` | ||
|
||
* **For developers and designers**: | ||
:doc:`/guides/private-python-packages` | | ||
:doc:`/guides/adding-custom-css` | | ||
:doc:`/guides/reproducible-builds` | | ||
:doc:`/guides/embedding-content` | | ||
:doc:`/guides/conda` | | ||
:doc:`Other guides for developers and designers </guides/developers>` | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:hidden: | ||
:caption: Step-by-step Guides | ||
:caption: How-to Guides | ||
|
||
/guides/tools | ||
/guides/platform | ||
/guides/commercial | ||
/guides/authors | ||
/guides/administrators | ||
/guides/developers | ||
|
||
Advanced features of Read the Docs | ||
---------------------------------- | ||
|
@@ -152,7 +175,8 @@ out of your documentation and Read the Docs. | |
|
||
* **Advanced project configuration**: | ||
:doc:`subprojects` | | ||
:doc:`Single version docs <single_version>` | ||
:doc:`Single version docs <single_version>` | | ||
:doc:`feature-flags` | ||
|
||
* **Multi-language documentation**: | ||
:doc:`Translations and localization <localization>` | ||
|
@@ -180,6 +204,7 @@ out of your documentation and Read the Docs. | |
|
||
subprojects | ||
single_version | ||
feature-flags | ||
|
||
localization | ||
|
||
|
Uh oh!
There was an error while loading. Please reload this page.