Skip to content

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

Merged
merged 2 commits into from
Jun 9, 2017
Merged

Initial version of theme. #1

merged 2 commits into from
Jun 9, 2017

Conversation

theacodes
Copy link
Collaborator

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.

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.
@theacodes theacodes requested review from brettcannon and ncoghlan June 5, 2017 21:40
@theacodes
Copy link
Collaborator Author

@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? :)

@brettcannon
Copy link
Member

@jonparrott sure

Copy link
Contributor

@ncoghlan ncoghlan left a 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
Copy link
Contributor

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.

Copy link
Collaborator Author

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:
Copy link
Contributor

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.

Copy link
Collaborator Author

@theacodes theacodes Jun 7, 2017

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. :)

@theacodes
Copy link
Collaborator Author

@ncoghlan please take another look when you get a chance. :)

Copy link
Contributor

@ncoghlan ncoghlan left a 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!

@theacodes
Copy link
Collaborator Author

theacodes commented Jun 9, 2017 via email

@zware zware deleted the initial-version branch December 10, 2019 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants