Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

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

  1. Near the top, add the following.:

    import pylons_sphinx_themes
    
  2. Activate the theme:

    html_theme = 'pyramid'
    html_theme_path = pylons_sphinx_themes.get_html_themes_path()
    
  3. 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
    ...
    
  4. (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)

Project details


Release history Release notifications

History Node

1.0.6

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0

History Node

0.3.1

History Node

0.3

This version
History Node

0.2.2

History Node

0.2.1

History Node

0.2

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pylons-sphinx-themes-0.2.2.tar.gz (140.1 kB) Copy SHA256 hash SHA256 Source None Apr 16, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page