diff --git a/ddportfolioservice/controllers/ddportfolio.py b/ddportfolioservice/controllers/ddportfolio.py index e6bbdb3..4af5597 100644 --- a/ddportfolioservice/controllers/ddportfolio.py +++ b/ddportfolioservice/controllers/ddportfolio.py @@ -37,6 +37,9 @@ log = logging.getLogger(__name__) class DdportfolioController(BaseController): + """ + Main controller for the Debian Member portfolio service. + """ _LABELS = { 'overview': { 'label': N_('Overview'), diff --git a/ddportfolioservice/model/__init__.py b/ddportfolioservice/model/__init__.py index f5029b6..a533c8d 100644 --- a/ddportfolioservice/model/__init__.py +++ b/ddportfolioservice/model/__init__.py @@ -20,3 +20,7 @@ # License along with this program. If not, see # . # +""" +Model classes and model related utilities for the Debian Member Portfolio +service. +""" diff --git a/docs/index.rst b/docs/index.rst index 28d90aa..aadf843 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,6 +16,7 @@ http://portfolio.debian.net/. .. toctree:: :maxdepth: 2 + sourcecode credits Indices and tables diff --git a/docs/sourcecode.rst b/docs/sourcecode.rst new file mode 100644 index 0000000..55cce3f --- /dev/null +++ b/docs/sourcecode.rst @@ -0,0 +1,95 @@ +Source documentation +==================== + +The sections below contain mostly autogenerated documentation of the source +code of the Debian Member Portfolio Service. + +Controllers +----------- + +.. automodule:: ddportfolioservice.controllers + :members: + +ddportfolio controller +~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: ddportfolioservice.controllers.ddportfolio + :members: + +error controller +~~~~~~~~~~~~~~~~ + +.. automodule:: ddportfolioservice.controllers.error + :members: + +showformscripts controller +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: ddportfolioservice.controllers.showformscripts + :members: + +template controller +~~~~~~~~~~~~~~~~~~~ + +.. automodule:: ddportfolioservice.controllers.template + :members: + +Library code +------------ + +.. automodule:: ddportfolioservice.lib + :members: + +app_globals +~~~~~~~~~~~ + +.. automodule:: ddportfolioservice.lib.app_globals + :members: + +base +~~~~ + +.. automodule:: ddportfolioservice.lib.base + :members: + +helpers +~~~~~~~ + +.. automodule:: ddportfolioservice.lib.helpers + :members: + +Model +----- + +.. automodule:: ddportfolioservice.model + :members: + +dddatabuilder +~~~~~~~~~~~~~ + +.. automodule:: ddportfolioservice.model.dddatabuilder + :members: + +form +~~~~ + +.. automodule:: ddportfolioservice.model.form + :members: + +keyfinder +~~~~~~~~~ + +.. automodule:: ddportfolioservice.model.keyfinder + :members: + +keyringanalyzer +~~~~~~~~~~~~~~~ + +.. automodule:: ddportfolioservice.model.keyringanalyzer + :members: + +urlbuilder +~~~~~~~~~~ + +.. automodule:: ddportfolioservice.model.urlbuilder + :members: