Skip to content
This repository was archived by the owner on Jun 28, 2023. It is now read-only.

Commit d03ad85

Browse files
committed
Add documentation with docstring support
1 parent 2cd8582 commit d03ad85

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

README.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,16 @@ Please visit ``https://travis-ci.org/profile/USERNAME``
127127
to open Travis CI support for your repo.
128128

129129

130+
Documentation
131+
========================================
132+
133+
.. code-block:: sh
134+
135+
sphinx-apidoc -o doc/api everywhere/
136+
python setup.py build_sphinx -s doc/
137+
138+
139+
130140
Comunication
131141
========================================
132142

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
extensions = ['sphinx.ext.autodoc']
12
master_doc = 'index'

doc/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,16 @@ python-everywhere
33
========================================
44

55
Generate your documentation with Sphinx :D
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
api/modules.rst
11+
12+
13+
Indices and tables
14+
==================
15+
16+
* :ref:`genindex`
17+
* :ref:`modindex`
18+
* :ref:`search`

0 commit comments

Comments
 (0)