Skip to content
Permalink
Browse files

Build complete module documentation using sphinx-autodoc

  • Loading branch information...
lukasjuhrich committed Mar 3, 2019
1 parent 885828d commit 71d0bf06329190c80995df2126661a6a76aa95c4
Showing with 21 additions and 51 deletions.
  1. +2 −1 .gitignore
  2. +1 −0 Makefile
  3. +2 −0 docs/source/backends.rst
  4. +2 −1 docs/source/index.rst
  5. +11 −10 docs/source/model.rst
  6. +3 −39 docs/source/sipa.rst
@@ -170,4 +170,5 @@ config.py
# documentation builds shall be checked into gh-pages or children of
# that
/docs/build
TAGS
TAGS
/docs/source/ref
@@ -18,6 +18,7 @@ translate:
pybabel compile -d sipa/translations/

docs:
sphinx-apidoc -o docs/source/ref sipa
$(MAKE) -C docs html

show_docs:
@@ -10,6 +10,7 @@ sipa.backends
.. autoclass:: Backends
:members:
:undoc-members:
:noindex:

.. data:: backends

@@ -32,3 +33,4 @@ Sipa distinguishes between two concepts:
:member-order: bysource
:members:
:undoc-members:
:noindex:
@@ -20,7 +20,7 @@ user's properties foran arbitrary backend.
This is


Package reference
Package survey
-----------------

.. toctree::
@@ -29,6 +29,7 @@ Package reference
sipa
backends
model
Complete Reference <ref/modules>


Indices and tables
@@ -1,8 +1,8 @@
============
`sipa.model`
============
=====
Model
=====

The `model` package mainly contains:
The :mod:`sipa.model` package mainly contains:

#. :class:`~sipa.backends.datasource.Datasource` implementations for the
:py:mod:`sipa.backends` extension and everything that comes with it
@@ -20,6 +20,7 @@ Implemented backends
Sipa registers the following datasources:

.. autodata:: sipa.model.AVAILABLE_DATASOURCES
:noindex:

Their implementations are in the corresponding modules

@@ -28,13 +29,11 @@ Their implementations are in the corresponding modules
* :mod:`sipa.model.sample`


`.user`
-------
User
----

.. automodule:: sipa.model.user
:member-order: groupwise
:members:
:undoc-members:
.. class:: sipa.model.user.BaseUser
:noindex:


`.fancy_property`
@@ -48,6 +47,7 @@ Their implementations are in the corresponding modules
:member-order: bysource
:members:
:undoc-members:
:noindex:


`.finance`
@@ -61,3 +61,4 @@ of the finance information:
:members:
:private-members:
:undoc-members:
:noindex:
@@ -7,48 +7,12 @@ subpackages are mainly frontend-related.

`.blueprints`
-------------
The `sipa.blueprints` package contains the actual endpoint definitions.
The :mod:`sipa.blueprints` package contains the actual endpoint definitions.
For an overview of flask blueprints, refer to the :ref:`flask documentation <flask:blueprints>`.

`.initialization`
-----------------

.. automodule:: sipa.initialization
:members:

`.mail`
-------

.. automodule:: sipa.mail
:members:

`.units`
--------

.. automodule:: sipa.units
:members:
:undoc-members:

`.base`
-------

.. automodule:: sipa.base
:members:

`.babel`
--------

.. automodule:: sipa.babel
:members:
:undoc-members:
:exclude-members: request

`.flatpages`
------------

.. automodule:: sipa.flatpages
:members:
:undoc-members:
:private-members:
:special-members: __getattr__
:exclude-members: request
The :mod:`sipa.flatpages` module provides the :class:`~sipa.flatpages.CategorizedFlatPages`
flask extension, which is based on :mod:`Flask-FlatPages <ffp:flask_flatpages>`.

0 comments on commit 71d0bf0

Please sign in to comment.
You can’t perform that action at this time.