-
-
Notifications
You must be signed in to change notification settings - Fork 65
Initial version of theme. #1
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
Conversation
Extracted from CPython @ 1bced5656 Added a few more theme config values, split the donate footer into its own template, and removed CPython-docs sepcific JavaScript and HTML.
@brettcannon FYI I have a working version of the CPython docs that use this theme (and removes duplicated code), should I send that over to CPython after this is merged? :) |
@jonparrott sure |
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.
Mostly looks good to me, just the extra README paragraph requested, and a question about the use of the io
module in setup.py
README.rst
Outdated
Python Docs Sphinx Theme | ||
========================= | ||
|
||
This is the theme for the Python documentation |
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.
The note from the python-dev discussion can just be added here as a second paragraph:
Note that when adopting this theme, you're also borrowing an element of the trust and credibility established by the CPython core developers over the years. That's fine, and you're welcome to do so for other Python community projects if you so choose, but please keep in mind that in doing so you're also choosing to accept some of the responsibility for maintaining that collective trust.
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.
Done, thank you. :)
from setuptools import setup | ||
|
||
# README into long description | ||
with io.open('README.rst', encoding='utf-8') as readme_file: |
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.
Are we planning to support installing this theme for use in Py2 docs builds? If not, we can just use the open() builtin directly here, rather than going through the io
module.
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.
Although this is technically for the Python 3 docs, using io.open
over open
is pretty cheap for us, especially considering this package contains almost no Python code. :)
@ncoghlan please take another look when you get a chance. :) |
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.
Looks good to me!
Thanks!
…On Thu, Jun 8, 2017, 8:21 PM Nick Coghlan ***@***.***> wrote:
Merged #1 <#1>.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#1 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAPUc0au4b50AlsiQuHwRBl9BqAy0Oa_ks5sCLozgaJpZM4NwmdZ>
.
|
Extracted from CPython @ 1bced5656
Added a few more theme config values, split the donate footer into its own template, and removed CPython-docs sepcific JavaScript and HTML.