Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mbodenhamer committed Apr 20, 2016
1 parent 334cc23 commit 8f419c5
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Makefile
Expand Up @@ -41,8 +41,8 @@ build: check
# Documentation

docs:
@$(PYDEV) sphinx-apidoc -f -o docs/ syn/ $$(find syn -name tests)
@$(PYDEV) make -C docs html
@$(PYDEV) bash -c "pip install -e .; sphinx-apidoc -f -o docs/ syn/ $$(find syn -name tests); make -C docs html"
# @$(PYDEV) make -C docs html

view:
@python -c "import webbrowser as wb; \
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -25,7 +25,7 @@ def read(fpath):
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('..'))
#sys.path.insert(0, os.path.abspath('..'))

# -- General configuration ------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Expand Up @@ -10,7 +10,7 @@ Contents:
.. toctree::
:maxdepth: 2

syn
syn.utils
changelog

Indices and tables
Expand Down
22 changes: 22 additions & 0 deletions docs/syn.utils.cmdargs.rst
@@ -0,0 +1,22 @@
syn.utils.cmdargs package
=========================

Submodules
----------

syn.utils.cmdargs.args module
-----------------------------

.. automodule:: syn.utils.cmdargs.args
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: syn.utils.cmdargs
:members:
:undoc-members:
:show-inheritance:
17 changes: 17 additions & 0 deletions docs/syn.utils.rst
@@ -0,0 +1,17 @@
syn.utils package
=================

Subpackages
-----------

.. toctree::

syn.utils.cmdargs

Module contents
---------------

.. automodule:: syn.utils
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 8f419c5

Please sign in to comment.