TRON-2186: Fix docs build on latest release #963
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
….md as it has not been updated in years
bobokun
force-pushed
the
u/jonlee/TRON-2186-fix2
branch
from
3091e59
to
a3309dc
Compare
nemacysts
reviewed
May 14, 2024
tox.ini
Outdated
| @@ -35,13 +35,15 @@ ignore = E501,E265,E241,E704,E251,W504,E231,W503,E203 | |||
| [testenv:docs] | |||
| deps = | |||
| --requirement={toxinidir}/requirements-docs.txt | |||
| --requirement={toxinidir}/requirements-minimal.txt | |||
There was a problem hiding this comment.
requirements-minimal.txt is not meant to be installed - if we need a real venv, we probably want to install from requirements.txt instead
and just curious: what error is this fixing?
There was a problem hiding this comment.
… but was accidentally commited after moving to source/
nemacysts
approved these changes
May 14, 2024
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.
This should fix the docs building on the latest version.
I've also updated the changelog to point to the latest release and removed the
CHANGELOG.mdwhich hasn't been updated since 2019.The additional requirement for
requirements.txtis necessary in order to generate the api docsI've removed any auto generated docs and build from the repo as well (They were excluded previously in .gitignore but was missed after moving the doc files to docs/source)