Documentation Build Fix #164
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
iampelle
added a commit
that referenced
this pull request
Aug 23, 2023
* Documentation Build Fix (#164) * Added readthedocs config yaml file * Updated broken paths in docs * fix: requirements.txt to reduce vulnerabilities (#163) The following vulnerabilities are fixed by pinning transitive dependencies: - https://snyk.io/vuln/SNYK-PYTHON-TORNADO-5537286 * - Update version and history --------- Co-authored-by: lrjball <50599110+lrjball@users.noreply.github.com> Co-authored-by: Snyk bot <github+bot@snyk.io>
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.
What this PR does / why we need it:
The build for the documentation seems to have been broken for a while, as mentioned in #42. Additionally, readthedocs are soon deprecating the existing config methodology in favor of the .readthedocs.yaml file, so all builds not using this by 25th September will fail automatically (see https://blog.readthedocs.com/migrate-configuration-v2/).
This PR fixes the documentation build and migrates to the new .readthedocs.yaml config file, while also fixing a few of the broken links as mentioned in #160.
I've tested the docs build on my fork (see https://chartify-lrjball.readthedocs.io/en/latest/index.html) and it all builds successfully, reflecting the latest state of the package (for example the history tab now shows all of the latest releases) and without the broken links.
Note, the previous config for the docs was specified in the web portal for readthedocs which is only accessible to the project owner, but the .readthedocs.yaml file will override these config values so it should work once merged in without requiring any further changes in the readthedocs portal.
Which issue(s) this PR fixes
Fixes #42, Fixes #160