Docs: Update to use yaml files #545
Merged
Conversation
This file contains 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
Read the Docs has moved to a yaml file format that is needed to continue building our docs in the future. - Adds yaml files for doc and doc-dev - Fix reference link - Remove static path from developer docs - Update developer docs version NOTE: fail_on_warning and builds for pull requests can be enabled in the future if desired. This will error on doc changes that violate rst syntax (can be finicky) and add a build status report to open pull requests.
CamStan
commented
Sep 20, 2023
Comment on lines
+25
to
+27
| python: | ||
| install: | ||
| - requirements: doc/requirements.txt |
There was a problem hiding this comment.
For future reference, the docutils version constraint we have in the requirements file might not be necessary anymore (this built in my test repo without it). I left it here as it still works, and we may want to use this file for reproducible builds in the future.
gonsie
approved these changes
Sep 22, 2023
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.
Read the Docs has moved to a yaml file format that is needed to continue building our docs in the future.
NOTE:
fail_on_warningand builds for pull requests can be enabled in the future if desired. This will error on doc changes that violate rst syntax (can be finicky) and add a build status report to open pull requests.