diff --git a/Makefile b/Makefile index 123e939..4d4052c 100644 --- a/Makefile +++ b/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 diff --git a/docs/api/django_downloadview.txt b/docs/api/django_downloadview.txt new file mode 100644 index 0000000..a6255ec --- /dev/null +++ b/docs/api/django_downloadview.txt @@ -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: + diff --git a/docs/api/modules.txt b/docs/api/modules.txt new file mode 100644 index 0000000..bb6a157 --- /dev/null +++ b/docs/api/modules.txt @@ -0,0 +1,7 @@ +django_downloadview +=================== + +.. toctree:: + :maxdepth: 4 + + django_downloadview diff --git a/docs/index.txt b/docs/index.txt index b932958..235d7e8 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -5,6 +5,7 @@ .. include:: ../README + ******** Contents ******** @@ -12,10 +13,12 @@ Contents .. toctree:: :maxdepth: 2 + api/modules +****************** Indices and tables -================== +****************** * :ref:`genindex` * :ref:`modindex`