mirror of
https://github.com/kennethreitz-archive/sphinx-to-github.git
synced 2026-06-05 23:40:17 +00:00
Adjusted README to reflect latest contributions
This commit is contained in:
+31
-15
@@ -1,6 +1,9 @@
|
||||
Sphinx to GitHub
|
||||
================
|
||||
|
||||
About
|
||||
-----
|
||||
|
||||
A Python script for preparing the html output of the Sphinx documentation
|
||||
system for github pages.
|
||||
|
||||
@@ -8,25 +11,19 @@ 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.
|
||||
|
||||
How?
|
||||
----
|
||||
Usage
|
||||
-----
|
||||
|
||||
The ``sphinxtogithub.py`` script can be run on the command line or used as a
|
||||
Sphinx extension.
|
||||
|
||||
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.
|
||||
|
||||
Extension
|
||||
~~~~~~~~~
|
||||
|
||||
@@ -42,21 +39,38 @@ 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.
|
||||
|
||||
Further Information
|
||||
-------------------
|
||||
|
||||
Install from GitHub
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
It should be possible to install this tool directly from github using pip::
|
||||
|
||||
pip install -e git+git://github.com/michaeljones/sphinx-to-github.git#egg=sphinx-to-github
|
||||
|
||||
Thanks to `winhamwr's <http://github.com/winhamwr>`_ work.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
~~~~~~~~~~~~
|
||||
|
||||
The script uses ``/usr/bin/env`` and ``python``.
|
||||
|
||||
Running Tests
|
||||
-------------
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Unit tests can be run using the setuptools ``test`` target. eg::
|
||||
|
||||
$ python setup.py test
|
||||
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
~~~~~~~~~~~~
|
||||
|
||||
`dinoboff's <http://github.com/dinoboff>`_ project `github-tools
|
||||
<http://github.com/dinoboff/github-tools>`_ provides similar functionality
|
||||
@@ -71,8 +85,10 @@ Thank you to:
|
||||
* `mikejs <http://github.com/mikejs>`_
|
||||
* `certik <http://github.com/certik>`_
|
||||
* `davvid <http://github.com/davvid>`_
|
||||
* `winhamwr <http://github.com/winhamwr>`_
|
||||
|
||||
For their contributions, to Georg Brandl for `Sphinx <http://sphinx.pocoo.org/>`_
|
||||
and the github crew for the pages functionality.
|
||||
For their contributions, which are beginning to outweigh mine, to Georg Brandl
|
||||
for `Sphinx <http://sphinx.pocoo.org/>`_ and the github crew for the pages
|
||||
functionality.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user