Docs: split user and dev docs #8751
Conversation
stsewd
force-pushed
the
separate-dev-docs
branch
from
5ad9935 to
efb0714
Compare
|
If I understand correctly, a single |
yeah, hopefully in the future we can use individual rtd config files (mostly to have different search ranking/ignore for each one). This was Anthony's idea actually :D Test are failing because https://dev.readthedocs.io/en/stable/ has the contents from master instead of the new content, it will have the new content after this PR is merged (and we push a tag, since intersphinx is pointing to "stable", could also point it to latest till we do another release). Previews at: Redirects are in place. |
| @@ -66,6 +96,8 @@ def get_version(): | |||
| 'jupyterbook': ('https://jupyterbook.org/', None), | |||
| 'myst-parser': ('https://myst-parser.readthedocs.io/en/v0.15.1/', None), | |||
| 'rst-to-myst': ('https://rst-to-myst.readthedocs.io/en/stable/', None), | |||
| 'rtd': ('https://docs.readthedocs.io/en/stable/', None), | |||
| 'rtd-dev': ('https://dev.readthedocs.io/en/stable/', None), | |||
There was a problem hiding this comment.
Locally I'm testing this with
| 'rtd-dev': ('https://dev.readthedocs.io/en/stable/', None), | |
| 'rtd-dev': ('https://dev.readthedocs.io/en/separate-dev-docs/', None), |
|
Minor thing: is there a chance we could tweak the theme a bit to give these docs a distinct visual identity? Something like:
( |
|
@astrojuanlu we could do that, I was also thinking we could have a different logo. We may need help from @readthedocs/frontend for these visual changes :) |
|
Agreed, this looks good to me, so lets move forward with it. The redirects are the main thing. |
|
Merging, and fixing tests later 👍 |
|
Looks like @stsewd already created the redirects, and they're working 🎉 |
This splits the docs in two, one set container user-facing documentation, and the other one containing development documentation. The structure is like
The user facing docs will be served from https://docs.readthedocs.io/ (just as they are today), and the dev docs will be served from https://dev.readthedocs.io/.
To build each docset you need to set the
RTD_DOCSETenv var (defaults to the user documentation), docs have been updated to mention this, there is also some explanation on the conf.py file.I'm not really sure what will happen with the localization strings (I left them in the docs/user dir)