diff options
| author |   Tim Harder <radhermit@gmail.com> | 2014-10-30 00:22:39 -0400 |
|---|---|---|
| committer | Tim Harder <radhermit@gmail.com> | 2014-10-30 00:28:01 -0400 |
| commit | edb7e026efc07bb0abf8a46d8756e0bf6fbe67b9 (patch) | |
| tree | 015b83e99fe777f156d73b3779838fffd9648112 /doc | |
| parent | doc: move badges to the end of the readme and remove landscape badge (diff) | |
| download | snakeoil-edb7e026efc07bb0abf8a46d8756e0bf6fbe67b9.tar.gz snakeoil-edb7e026efc07bb0abf8a46d8756e0bf6fbe67b9.tar.bz2 snakeoil-edb7e026efc07bb0abf8a46d8756e0bf6fbe67b9.zip | |
doc: use sphinx-apidoc to auto-generate api documentation
This also drops some of the snakeoil.test API from being documented, but
realistically the only consumer of that should probably be pkgcore and
related tools.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 11 | ||||
| -rw-r--r-- | doc/api.rst | 40 | ||||
| -rw-r--r-- | doc/index.rst | 2 | ||||
| -rw-r--r-- | doc/public_modules.txt | 31 |
4 files changed, 3 insertions, 81 deletions
diff --git a/doc/Makefile b/doc/Makefile index c1cc541..af699a3 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -41,15 +41,8 @@ help: clean: -rm -rf $(BUILDDIR) api -generated: api - -api: - @echo "autogenerating api rsts..." - @mkdir -p api - @echo "pythonpath=${PYTHONPATH}" - @for fn in `cat public_modules.txt`; \ - do echo $${fn} api/$${fn}.rst; \ - done | $(PYTHON) -m snakeoil.sphinx_utils.generate_api_rsts +generated: + sphinx-apidoc -ef -o api ../snakeoil ../snakeoil/test html: generated $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html diff --git a/doc/api.rst b/doc/api.rst deleted file mode 100644 index 4070aba..0000000 --- a/doc/api.rst +++ /dev/null @@ -1,40 +0,0 @@ -API Documentation -================= - -Modules -======= - -.. autosummary:: - :toctree: api - - snakeoil.bash - snakeoil.caching - snakeoil.caching_2to3 - snakeoil.chksum - snakeoil.compatibility - snakeoil.containers - snakeoil.currying - snakeoil.data_source - snakeoil.demandload - snakeoil.dependant_methods - snakeoil.descriptors - snakeoil.distutils_extensions - snakeoil.fileutils - snakeoil.formatters - snakeoil.iterables - snakeoil.klass - snakeoil.lists - snakeoil.mappings - snakeoil.modules - snakeoil.obj - snakeoil.osutils - snakeoil.pickling - snakeoil.stringio - snakeoil.struct_compat - snakeoil.tar - snakeoil.test - snakeoil.test.mixins - snakeoil.unittest_extensions - snakeoil.version - snakeoil.weakrefs - snakeoil.xml diff --git a/doc/index.rst b/doc/index.rst index 4686983..3565074 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -154,7 +154,7 @@ General Contents: .. toctree:: :maxdepth: 2 - api + api/modules news Indices and tables diff --git a/doc/public_modules.txt b/doc/public_modules.txt deleted file mode 100644 index e969d33..0000000 --- a/doc/public_modules.txt +++ /dev/null @@ -1,31 +0,0 @@ -snakeoil.bash -snakeoil.caching -snakeoil.caching_2to3 -snakeoil.chksum -snakeoil.compatibility -snakeoil.containers -snakeoil.currying -snakeoil.data_source -snakeoil.demandload -snakeoil.dependant_methods -snakeoil.descriptors -snakeoil.distutils_extensions -snakeoil.fileutils -snakeoil.formatters -snakeoil.iterables -snakeoil.klass -snakeoil.lists -snakeoil.mappings -snakeoil.modules -snakeoil.obj -snakeoil.osutils -snakeoil.pickling -snakeoil.stringio -snakeoil.struct_compat -snakeoil.tar -snakeoil.test -snakeoil.test.mixins -snakeoil.unittest_extensions -snakeoil.version -snakeoil.weakrefs -snakeoil.xml |