skip to navigation
skip to content

Not Logged In

agoraplex.themes.sphinx 0.1.2

A Sphinx theme for Agoraplex projects, based on the Pylons Sphinx theme

Latest Version: 0.1.3

This repository contains Sphinx themes for Agoraplex projects, based on the Pylons Sphinx Themes, and some helper roles. The following themes exist:

  • agoraplex - the generic Agoraplex documentation theme

Requirements

To rebuild the graphics from the SVG originals (which requires cloning the github repository):

  • rsvg-convert from librsvg
  • pngtopam, pnmremap, pnmcolormap, and pnmtopng from Netpbm
  • icotool from icoutils

Installation

To use a theme in your Sphinx documentation, follow this guide:

  1. Install the package:

    $ pip install agoraplex.themes.sphinx
    
  2. Edit your conf.py doc configuration file to point to the agoraplex theme:

    import agoraplex.themes.sphinx
    
    # ...
    
    html_theme = 'agoraplex'
    html_theme_path = agoraplex.themes.sphinx.get_html_theme_path()
    

Helpers

This package adds several Sphinx helper roles (in roles.py). To use these, add agoraplex.themes.sphinx.roles to the extensions list in your conf.py.

The roles are:

  • github: link to a github project:

    :github:`agoraplex/themes`
    

    The github_url configuration directive defaults to https://github.com/.

  • pypi: link to a project record at PyPi, the Python Package Index:

    :pypi:`agoraplex.themes.sphinx`
    

    The pypi_url configuration directive defaults to http://pypi.python.org/pypi/

  • wikipedia: link to a Wikipedia article:

    :wikipedia:`Ancient Agora of Athens`
    

    The wikipedia_url and wikipedia_lang configuration directives default to http://%s.wikipedia.org/wiki/ and en, respectively. Note that the wikipedia_url directive must contain a %s, where the role will insert the wikipedia_lang value.

    The wikipedia role will (mostly) canonicalize an article name by replacing spaces with underscores (_), uppercasing the first letter of the name, and lowercasing the rest. Wikipedia's own URL rewriting is tolerant of case mismatch, so these simplistic rules work well enough.

Configuration

In addition to the role-related configuration directives, this theme adds the following directives to the set defined by the original Pylons theme:

  • fontsets: a space-separated list of directory names, relative to the font directory (_static/fonts), from which to load a stylesheet.css file containing @font-face directives.
  • font_body, font_header: the 'base' names of the fonts to use for body and header text, respectively.

Note

The stylesheets assume that the font family is actually named <fontname>Regular. So, to use NeutonRegular as the header font (which is the default), theme.conf would specify font_header=Neuton.

 
File Type Py Version Uploaded on Size
agoraplex.themes.sphinx-0.1.2-py2.7.egg (md5) Python Egg 2.7 2013-02-08 643KB
agoraplex.themes.sphinx-0.1.2.tar.gz (md5) Source 2013-02-08 643KB
  • Downloads (All Versions):
  • 77 downloads in the last day
  • 457 downloads in the last week
  • 1646 downloads in the last month