mirror of
https://github.com/jazzband/django-downloadview.git
synced 2026-03-16 22:40:25 +00:00
Introduced API documentation. Not complete yet, since docstrings are not verbose.
This commit is contained in:
parent
33ad5d492e
commit
36e862d1c0
4 changed files with 39 additions and 2 deletions
10
Makefile
10
Makefile
|
|
@ -59,9 +59,17 @@ test:
|
|||
bin/demo test demo
|
||||
|
||||
|
||||
documentation:
|
||||
apidoc:
|
||||
rm -rf docs/api/*
|
||||
bin/sphinx-apidoc --suffix txt --output-dir $(ROOT_DIR)/docs/api django_downloadview
|
||||
|
||||
|
||||
sphinx:
|
||||
make --directory=docs clean html doctest
|
||||
|
||||
|
||||
documentation: apidoc sphinx
|
||||
|
||||
|
||||
release:
|
||||
bin/fullrelease
|
||||
|
|
|
|||
19
docs/api/django_downloadview.txt
Normal file
19
docs/api/django_downloadview.txt
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
django_downloadview Package
|
||||
===========================
|
||||
|
||||
:mod:`django_downloadview` Package
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: django_downloadview.__init__
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
:mod:`views` Module
|
||||
-------------------
|
||||
|
||||
.. automodule:: django_downloadview.views
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
7
docs/api/modules.txt
Normal file
7
docs/api/modules.txt
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
django_downloadview
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
django_downloadview
|
||||
|
|
@ -5,6 +5,7 @@
|
|||
|
||||
.. include:: ../README
|
||||
|
||||
|
||||
********
|
||||
Contents
|
||||
********
|
||||
|
|
@ -12,10 +13,12 @@ Contents
|
|||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api/modules
|
||||
|
||||
|
||||
******************
|
||||
Indices and tables
|
||||
==================
|
||||
******************
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
|
|
|
|||
Loading…
Reference in a new issue