-
-
Notifications
You must be signed in to change notification settings - Fork 30k
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
bpo-45729: [doc] Add license_url for python-docs-theme 2022.1. #30527
Conversation
1d6acfd
to
11ccc6b
Compare
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.
Confirmed fixed:
cd Doc
make clean-venv
make venv
make html
make serve
open http://localhost:8000/
main
PR
note
make clean-venv venv
were needed because without it it used an old version of the theme:
$ make html
...
preparing documents... failed
Warning, treated as error:
unsupported theme option 'license_url' given
make: *** [build] Error 2
We could add a lower bound for the theme in Doc/make.bat
and , but if it's always installed in a fresh venv should be okay.Doc/requirements.txt
I fixed the minimum version on Docs/requirements.txt to ensure nobody get the error about the theme variable not being known. I'll merge this as it fixes the doc on docs.python.org. I don't think make.bat needs it, but if it need it another PR could be created for it. |
Thanks @JulienPalard for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10. |
Thanks @hugovk for the review and the test! |
(cherry picked from commit 6f05e1e) Co-authored-by: Julien Palard <julien@palard.fr>
GH-30540 is a backport of this pull request to the 3.10 branch. |
(cherry picked from commit 6f05e1e) Co-authored-by: Julien Palard <julien@palard.fr>
GH-30541 is a backport of this pull request to the 3.9 branch. |
That works for new venvs, but not existing ones. The makefile does not always run |
I also changed issues_url so it serve local pages when using
make serve
locally.It'll also works on prod as
/license.html
redirects to/3/license.html
(same for/bugs.html
).https://bugs.python.org/issue45729