https://github.com/pylons/pylons_sphinx_theme
Pylons Sphinx Theme
https://github.com/pylons/pylons_sphinx_theme
Last synced: 6 months ago
JSON representation
Pylons Sphinx Theme
- Host: GitHub
- URL: https://github.com/pylons/pylons_sphinx_theme
- Owner: Pylons
- License: other
- Created: 2010-10-30T21:48:55.000Z (about 15 years ago)
- Default Branch: master
- Last Pushed: 2017-09-22T20:17:24.000Z (over 8 years ago)
- Last Synced: 2024-04-08T17:10:56.358Z (almost 2 years ago)
- Language: CSS
- Homepage: http://pylonsproject.org
- Size: 431 KB
- Stars: 13
- Watchers: 8
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.txt
- License: LICENSE.txt
Awesome Lists containing this project
README
Pylons Sphinx Theme
===================
This repository contains Pylons themes for Pylons related projects.
To use a theme in your Sphinx documentation, follow this guide:
1. put this directory as _themes into your docs folder. Alternatively
you can also use git submodules to check out the contents there
or symlink this directory as _themes.
2. add this to your conf.py::
sys.path.append(os.path.abspath('_themes'))
html_theme_path = ['_themes']
html_theme = 'pylons'
3. (optional) set a canonical root url in conf.py::
html_theme_options = dict(
canonical_url='http://the_root_domain/latest/docs/'
)
The url points to the root of the documentation. 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