forked from jan/debianmemberportfolio
add source reference in docs/sourcecode.rst
* ddportfolioservice/controllers/ddportfolio.py - add docstring to DdportfolioController * ddportfolioservice/model/__init__.py - add module docstring * docs/index.rst - add link to sourcecode file * docs/sourcecode.rst - include autogenerated module information
This commit is contained in:
parent
b000e08b3f
commit
599f10a6bb
4 changed files with 103 additions and 0 deletions
|
@ -37,6 +37,9 @@ log = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class DdportfolioController(BaseController):
|
class DdportfolioController(BaseController):
|
||||||
|
"""
|
||||||
|
Main controller for the Debian Member portfolio service.
|
||||||
|
"""
|
||||||
_LABELS = {
|
_LABELS = {
|
||||||
'overview': {
|
'overview': {
|
||||||
'label': N_('Overview'),
|
'label': N_('Overview'),
|
||||||
|
|
|
@ -20,3 +20,7 @@
|
||||||
# License along with this program. If not, see
|
# License along with this program. If not, see
|
||||||
# <http://www.gnu.org/licenses/>.
|
# <http://www.gnu.org/licenses/>.
|
||||||
#
|
#
|
||||||
|
"""
|
||||||
|
Model classes and model related utilities for the Debian Member Portfolio
|
||||||
|
service.
|
||||||
|
"""
|
||||||
|
|
|
@ -16,6 +16,7 @@ http://portfolio.debian.net/.
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
sourcecode
|
||||||
credits
|
credits
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
|
95
docs/sourcecode.rst
Normal file
95
docs/sourcecode.rst
Normal file
|
@ -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:
|
Loading…
Reference in a new issue