Separate trees for user and developer docs#966
Open
ekapadi wants to merge 7 commits intoneutrons:nextfrom
Open
Separate trees for user and developer docs#966ekapadi wants to merge 7 commits intoneutrons:nextfrom
ekapadi wants to merge 7 commits intoneutrons:nextfrom
Conversation
This PR includes the following changes:
* Create separate trees for user-docs and developer-docs;
* Update `.readthedocs.yml` for the new locations;
* Fix pixi build-documentation tasks so that they actually work.
In this regard please note that, for historical purposes, I've saved the original `docs/rtd/Makefile`
to the new location `PyRS/docs/user/Makefile` but I have not otherwise updated it.
Documentation: user / developer docs tree; fix pixi doc-build tasks.
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Short description of the changes:
This PR includes the following changes:
Create separate trees for user-docs and developer-docs;
Update
.readthedocs.ymlfor the new locations;Fix pixi build-documentation tasks so that they actually work. In this regard please note that, for historical purposes, I've saved the original
docs/rtd/Makefileto the new locationdocs/user/Makefilebut I have not otherwise updated it.Check list for the pull request
Check list for the reviewer
Manual test for the reviewer
It's important to verify that the pixi build-documentation commands actually work, these are:
References
EWM#12482