This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!
Project Description

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.

Release History

Release History

0.1.3

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
agoraplex.themes.sphinx-0.1.3-py2.7.egg (658.4 kB) Copy SHA256 Checksum SHA256 2.7 Egg Feb 13, 2013
agoraplex.themes.sphinx-0.1.3.tar.gz (659.3 kB) Copy SHA256 Checksum SHA256 Source Feb 13, 2013

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting