sphinxtogithub 1.0.0

Script to prepare Sphinx HTML output for github pages
LICENSE TYPE:
BSD License 
USER RATING:
UNRATED
  0.0/5
DEVELOPED BY:
Michael Jones
HOMEPAGE:
github.com
CATEGORY:
ROOT \ Documentation
sphinxtogithub is a Python script for preparing the HTML output of the Sphinx documentation system for github pages.

It renames any top level folders which start with an underscore and edits any references to them within the html files.

Why?

GitHub processes the incoming html with Jekyll which believes top level folders starting with an underscore are special and does not let their content be accessible to the server. This is incompatible with Sphinx which uses underscores at the start of folder names for static content.

Usage

The sphinxtogithub.py script can be run on the command line or used as a Sphinx extension.

Extension

Place the script on the PYTHONPATH and add sphinxtogithub to the extensions list in the conf.py file in your Sphinx project:

extensions = [ "sphinxtogithub" ]

Additionally there are two config variables you can use to control the extension. The first enables/disables the extension and the second enables verbose output. They are True by default:

sphinx_to_github = True
sphinx_to_github_verbose = True


Command Line

Run the script with the path to the html output directory as the first argument. There is a --verbose flag for basic output.

Last updated on November 10th, 2010

requirements

#github pages #Sphinx documentation #Sphinx #github #pages #documentation

  Add it to your Download Basket!

 Add it to your Watch List!

0/5

Rate it!
send us
an update

Add your review!

SUBMIT