Tool for building restructured text documentation for projects with scripts in many languages
Project description
sphinx-script Script Documentation Module
=========================================
version number: 0.0.4
author: [Climate Impact Lab](http://impactlab.org)
Overview
--------
Tool for building restructured text documentation for projects with scripts in many languages
Installation
------------
To install use pip:
$ pip install sphinxscript
Or clone the repo:
$ git clone https://github.com/ClimateImpactLab/sphinxscript.git
$ python setup.py install
Usage
-----
Set up your repository using sphinx. Near the top of the `conf.py` configuration
file, place the following lines:
import sphinxscript
sphinxscript.build_docs()
Finally, in your sphinx index file `index.rst`, include the following:
.. toctree::
:maxdepth: 4
[project_folder_name]
replacing `[project_folder_name]` with the name of the directory containing your
source code.
Using Sphinx-script with ReadTheDocs
------------------------------------
Include `sphinxscript` in the file `requirements.txt` in your root project
directory. Then follow the usage steps above.
Contributing
------------
TBD
Example
-------
TBD
=========================================
version number: 0.0.4
author: [Climate Impact Lab](http://impactlab.org)
Overview
--------
Tool for building restructured text documentation for projects with scripts in many languages
Installation
------------
To install use pip:
$ pip install sphinxscript
Or clone the repo:
$ git clone https://github.com/ClimateImpactLab/sphinxscript.git
$ python setup.py install
Usage
-----
Set up your repository using sphinx. Near the top of the `conf.py` configuration
file, place the following lines:
import sphinxscript
sphinxscript.build_docs()
Finally, in your sphinx index file `index.rst`, include the following:
.. toctree::
:maxdepth: 4
[project_folder_name]
replacing `[project_folder_name]` with the name of the directory containing your
source code.
Using Sphinx-script with ReadTheDocs
------------------------------------
Include `sphinxscript` in the file `requirements.txt` in your root project
directory. Then follow the usage steps above.
Contributing
------------
TBD
Example
-------
TBD
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinxscript-0.0.4.tar.gz
(5.5 kB
view hashes)
Built Distribution
Close
Hashes for sphinxscript-0.0.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc78683744165bfe6c4dc81288b42eca5d07d33bea7772fa208e7936c1309127 |
|
MD5 | f82669452ead41938656c05ad1bbfe20 |
|
BLAKE2b-256 | c59a05029d149070e234c243023967a0e5d48bc85175c5aa3f83659c95050e5c |