diff --git a/.gitignore b/.gitignore index 829daa5..2a1c994 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,8 @@ coverage.xml dist/ docs/_build/ -docs/modules/ +docs/source/api/processors/ +docs/source/api/records/ .env env/ examples/migrating-to-octodns/config/ diff --git a/docs/conf.py b/docs/conf.py index ebbe7bd..63b8907 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,6 +16,7 @@ release = __version__ extensions = [ "sphinx.ext.autodoc", + "sphinx.ext.autosummary", "sphinx.ext.coverage", "sphinx.ext.napoleon", "sphinx.ext.intersphinx", diff --git a/docs/source/api/processor.rst b/docs/source/api/processor.rst index 60b5261..e2e1f07 100644 --- a/docs/source/api/processor.rst +++ b/docs/source/api/processor.rst @@ -55,33 +55,18 @@ domains added to the ``zones`` config in future then you can add this to the processors: - custom_meta - -.. autoclass:: octodns.processor.base.BaseProcessor - :inherited-members: - -.. automodule:: octodns.processor.acme - :inherited-members: - -.. automodule:: octodns.processor.arpa - :inherited-members: - -.. automodule:: octodns.processor.filter - :inherited-members: - -.. automodule:: octodns.processor.meta - :inherited-members: - -.. automodule:: octodns.processor.ownership - :inherited-members: - -.. automodule:: octodns.processor.restrict - :inherited-members: - -.. automodule:: octodns.processor.spf - :inherited-members: - -.. automodule:: octodns.processor.templating - :inherited-members: - -.. automodule:: octodns.processor.trailing_dots - :inherited-members: +.. currentmodule:: octodns.processor + +.. autosummary:: + :toctree: processors + + base + acme + arpa + filter + meta + ownership + restrict + spf + templating + trailing_dots diff --git a/docs/source/api/records.rst b/docs/source/api/records.rst index 17679cd..6426244 100644 --- a/docs/source/api/records.rst +++ b/docs/source/api/records.rst @@ -1,35 +1,38 @@ Records ======= -.. automodule:: octodns.record.base -.. automodule:: octodns.record.aaaa -.. automodule:: octodns.record.alias -.. automodule:: octodns.record.a -.. automodule:: octodns.record.caa -.. automodule:: octodns.record.change -.. automodule:: octodns.record.chunked -.. automodule:: octodns.record.cname -.. automodule:: octodns.record.dname -.. automodule:: octodns.record.ds -.. automodule:: octodns.record.dynamic -.. automodule:: octodns.record.exception -.. automodule:: octodns.record.geo_data -.. automodule:: octodns.record.geo -.. automodule:: octodns.record.https -.. automodule:: octodns.record.ip -.. automodule:: octodns.record.loc -.. automodule:: octodns.record.mx -.. automodule:: octodns.record.naptr -.. automodule:: octodns.record.ns -.. automodule:: octodns.record.ptr -.. automodule:: octodns.record.rr -.. automodule:: octodns.record.spf -.. automodule:: octodns.record.srv -.. automodule:: octodns.record.sshfp -.. automodule:: octodns.record.subnet -.. automodule:: octodns.record.svcb -.. automodule:: octodns.record.target -.. automodule:: octodns.record.tlsa -.. automodule:: octodns.record.txt -.. automodule:: octodns.record.uri -.. automodule:: octodns.record.urlfwd +.. autosummary:: + :toctree: records + + octodns.record.base + octodns.record.aaaa + octodns.record.alias + octodns.record.a + octodns.record.caa + octodns.record.change + octodns.record.chunked + octodns.record.cname + octodns.record.dname + octodns.record.ds + octodns.record.dynamic + octodns.record.exception + octodns.record.geo_data + octodns.record.geo + octodns.record.https + octodns.record.ip + octodns.record.loc + octodns.record.mx + octodns.record.naptr + octodns.record.ns + octodns.record.ptr + octodns.record.rr + octodns.record.spf + octodns.record.srv + octodns.record.sshfp + octodns.record.subnet + octodns.record.svcb + octodns.record.target + octodns.record.tlsa + octodns.record.txt + octodns.record.uri + octodns.record.urlfwd diff --git a/script/generate-docs b/script/generate-docs index b193f59..becca7e 100755 --- a/script/generate-docs +++ b/script/generate-docs @@ -22,6 +22,6 @@ if [ -z "$BUILDER" ]; then fi build="_build/${BUILDER}" -rm -rf "$build" +rm -rf "$build" source/api/records/ source/api/processors/ sphinx-build --builder "$BUILDER" --conf-dir . --fail-on-warning "$@" "source/" "$build"