Pylons Sphinx themes for documentation styling.
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 Sphinx documentation’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:
html_theme_options = dict( canonical_url='http://the_root_domain/latest/docs/' )
The URL points to the root of the documentation, and requires a trailing slash.
The following themes exist.
pylons - the generic Pylons Project documentation theme
pyramid - the specific Pyramid documentation theme
pylonsfw - the specific Pylons Framework documentation theme
0.1 (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.
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
File details
Details for the file pylons-sphinx-themes-0.2.1.tar.gz.
File metadata
- Download URL: pylons-sphinx-themes-0.2.1.tar.gz
- Upload date:
- Size: 140.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1bec42f87cf451af2dc5fcd779c30acbb6cca79819cd1f1abdd005b4683a12d6 |
|
| MD5 | 5835a712ebaff313afc47c269907c325 |
|
| BLAKE2b-256 | ed5ab2ed6161ae1f69e89097f46b28d65cb96bd11d4290fec1fb972ef22b4834 |
