Sphinx themes for Pylons Project documentation.
Project description
Pylons Sphinx Themes
This repository is a Python package that contains Sphinx themes for Pylons related projects. This project is based on Pylons Sphinx Theme (singular), but uses a package implementation instead of git submodules and manual steps.
To use a theme in your Sphinx documentation, follow this guide.
Edit your project’s setup.py
Add pylons-sphinx-themes to your project’s requirements in its setup.py. Here’s an example from Pyramid.
docs_extras = [ 'Sphinx >= 1.3.1', # Read The Docs minimum version 'docutils', 'repoze.sphinx.autointerface', 'pylons-sphinx-themes', ]
Edit your Sphinx’s conf.py
Near the top, add the following.
import pylons_sphinx_themes
Activate the theme.
html_theme = 'pyramid' html_theme_path = pylons_sphinx_themes.get_html_themes_path()
If you were previously using the git submodule method to use the Pylons theme, then comment or delete the block of code under the following statement.
# Add and use Pylons theme if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers
(Optional) Set a canonical root URL. The URL points to the root of the documentation, and requires a trailing slash.
html_theme_options = dict( canonical_url='http://the_root_domain/latest/docs/' )
Undo git submodule method
If you were previously using the git submodule method to use the Pylons theme, then perform the following additional steps.
Remove .gitmodules.
cd <your_project_directory> git rm .gitmodules
Deinitialize the submodule.
cd docs/_themes git submodule deinit .
Remove the submodule’s directory.
cd .. git rm _themes/
Edit your Sphinx’s Makefile. The following is an example diff from Pyramid.
-html: themes +html: # ... -htmlhelp: themes +htmlhelp: #... -themes: - cd ..; git submodule update --init --recursive; cd docs;
Update tox.ini
If you use tox, you can specify dependencies for building your docs either in your setup.py (preferred) or in your tox.ini (duplicitous). See the example from Pyramid.
docs_extras = [
'Sphinx >= 1.3.1',
'docutils',
'repoze.sphinx.autointerface',
'pylons_sphinx_latesturl',
'pylons-sphinx-themes',
]
# ...
extras_require = {
'testing':testing_extras,
'docs':docs_extras,
},
Otherwise you can repeat yourself and edit your tox.ini. The following example is from waitress.
deps =
Sphinx
repoze.sphinx.autointerface
pylons-sphinx-themes
Update Read the Docs configuration
If you specify package requirements for Read the Docs, specify dependencies in your rtd.txt. You can either name them explicitly, which might be duplicitous:
pylons-sphinx-themes
or you can rely on your setup.py configuration, specifying dependencies in only one place, by simply using this in your rtd.txt.
-e .[docs]
Available themes
pylons - the generic Pylons Project documentation theme
pyramid - the specific Pyramid documentation theme
pylonsfw - the specific Pylons Framework documentation theme
Change log for pylons-sphinx-themes
1.0.1 (2017-06-16)
Use zest.releaser for releasing.
Improve documentation.
0.3.1 (2015-04-15)
Improve documentation.
0.3 (2015-04-15)
Convert from using git submodule used in https://github.com/Pylons/pylons_sphinx_theme to a package. See https://github.com/Pylons/pyramid/issues/1614
Initial commit.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pylons-sphinx-themes-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | de54d97856728a00806f5724843217d1b676d5bdf00dd525b492708867e6d0bb |
|
MD5 | 322c205bf91dc92999551e4fe73d9893 |
|
BLAKE2b-256 | a69da5a7e4ee7d946701f55dce3fb53d957eb629233ed47e836cfb42754d9124 |
Hashes for pylons_sphinx_themes-1.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de3af27078b5c8ed9108576c672f0d9731b52bb501467603ae23d4a08092558a |
|
MD5 | 6b5a8d98b817fc64e05778ebb89b11ec |
|
BLAKE2b-256 | bd6a8524506433979809797662b0ad3f70ad12a45bd9afe41ff140e2623dbf08 |