Skip to content

/ python-docs-theme

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

Jump to bottom

Fixes #45: Added info about updating the conf.py file to README file #48

Open
wants to merge 1 commit into
base: master
from
Open

Fixes #45: Added info about updating the conf.py file to README file #48

wants to merge 1 commit into from

Conversation

@andy-maier
Copy link

@andy-maier andy-maier commented Jul 21, 2020

See commit message.
@andy-maier
Added info about updating the conf.py file to README file
0b5e117 
Details:

* It turns out that projects other than Python 3 that use the theme have to set
  it up in their conf.py files. This change adds the instructions to set that
  up, to the README file. See issue #45.

Signed-off-by: Andreas Maier <[email protected]>
@the-knights-who-say-ni
Copy link

@the-knights-who-say-ni the-knights-who-say-ni commented Jul 21, 2020

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@andy-maier

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!
@andy-maier
Copy link
Author

@andy-maier andy-maier commented Jul 21, 2020

I have now updated my existing b.p.o account to set my GitHub user, which was previously not set.
Let me know if I need to do anything else.
@andy-maier andy-maier mentioned this pull request Jul 21, 2020
Open
@JulienPalard
Copy link
Member

@JulienPalard JulienPalard commented Jul 23, 2020

As mentionned in #45, in cpython's conf.py we only use html_theme:

$ grep python.docs.theme ~/clones/python/cpython/Doc/conf.py 
html_theme = 'python_docs_theme'

no extensions, it would be interesting to understand why it works there and not for you before merging this.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
CLA signed
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
@andy-maier @the-knights-who-say-ni @JulienPalard
You can’t perform that action at this time.