-
Notifications
You must be signed in to change notification settings - Fork 59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
TRON-2186: Fix docs build on latest release #963
Conversation
….md as it has not been updated in years
3091e59
to
a3309dc
Compare
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
… but was accidentally commited after moving to source/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
imo, we could also get rid of the generated code docs from here + paasta without anyone noticing, but i guess it won't hurt to have these :p
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.md
which hasn't been updated since 2019.The additional requirement for
requirements.txt
is 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)