This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

Pysphinxdoc is a tool for generating automatically API documentation for Python modules, based on their reStructuredText docstrings, using the sikit-learn theme, Bootstrap and Sphinx. Visit this module documentation for a live example.

Here is an exemple to generate the ‘pysphinxdoc’ module documentation: first execute ‘sphinxdoc -v 2 -p $HOME/git/pysphinxdoc/ -n pysphinxdoc -o $HOME/git/pysphinxdoc/doc/’ and then in the $HOME/git/pysphinxdoc/doc/ folder ‘make raw-html’.

Expect a ‘$name_module/doc/source/_static’ folder containing a logo named ‘$name_module.png’ and an ‘carousel’ subfolder containing a list of images to be displayed in the index banner of the site.

The documentation is generated from the reStructuredText docstrings of each module, function or class.

In order to find module information, an ‘’ module is expected at the root of the module with mandatory keys:

  • NAME: the name of the module.
  • DESCRIPTION: the module short description that will be displayed in the banner.
  • LONG_DESCRIPTION: the index page content.
  • URL: the module URL.
  • AUTHOR: the author of the module.
  • AUTHOR_EMAIL: the author e-mail.
  • __version__: the module version.

And optional keys:

  • EXTRANAME: a name that will be displayed in the last element of the navbar (default ‘PYSPHINXDOC’).
  • EXTRAURL: the associated URL (default the pySphinxDoc URL).
Release History

Release History


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

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pysphinxdoc-1.0.0.tar.gz (301.2 kB) Copy SHA256 Checksum SHA256 Source Apr 13, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development 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