Skip to content
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

Merged
merged 1 commit into from Jan 11, 2022

Conversation

JulienPalard
Copy link
Member

@JulienPalard JulienPalard commented Jan 11, 2022

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

Copy link
Member

@hugovk hugovk left a 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

image

PR

image

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 Doc/requirements.txt, but if it's always installed in a fresh venv should be okay.

@JulienPalard
Copy link
Member Author

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.

@JulienPalard JulienPalard merged commit 6f05e1e into python:main Jan 11, 2022
@miss-islington
Copy link
Contributor

Thanks @JulienPalard for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

@JulienPalard JulienPalard deleted the mdk-license-url branch January 11, 2022 16:32
@JulienPalard
Copy link
Member Author

Thanks @hugovk for the review and the test!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 11, 2022
(cherry picked from commit 6f05e1e)

Co-authored-by: Julien Palard <julien@palard.fr>
@bedevere-bot
Copy link

GH-30540 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Jan 11, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 11, 2022
(cherry picked from commit 6f05e1e)

Co-authored-by: Julien Palard <julien@palard.fr>
@bedevere-bot
Copy link

GH-30541 is a backport of this pull request to the 3.9 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Jan 11, 2022
JulienPalard added a commit that referenced this pull request Jan 11, 2022
)

(cherry picked from commit 6f05e1e)

Co-authored-by: Julien Palard <julien@palard.fr>

Co-authored-by: Julien Palard <julien@palard.fr>
JulienPalard added a commit that referenced this pull request Jan 11, 2022
)

(cherry picked from commit 6f05e1e)

Co-authored-by: Julien Palard <julien@palard.fr>

Co-authored-by: Julien Palard <julien@palard.fr>
@merwok
Copy link
Member

merwok commented Jan 12, 2022

I fixed the minimum version on Docs/requirements.txt to ensure nobody get the error about the theme variable not being known.

That works for new venvs, but not existing ones. The makefile does not always run pip install -r requirements.txt, and there is no easy file to add as a target dependency to cause automatic update. So people will need to translate the error message into make clean-venv venv or venv/bin/pip install -r requirements.txt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants