Full doc coverage of the api and related cleanup

.changelog/5aab3287678b455f9644aa070a1e5457.md

@@ -0,0 +1,4 @@
+---
+type: none
+---
+Full doc coverage of the api and related cleanup

.gitignore

@@ -8,8 +8,13 @@
 coverage.xml
 dist/
 docs/_build/
+docs/api/cmds/
+docs/api/helpers/
 docs/api/processors/
+docs/api/providers/
 docs/api/records/
+docs/api/secrets/
+docs/api/sources/
 .env
 env/
 examples/migrating-to-octodns/config/

docs/api.rst

@@ -3,8 +3,6 @@
 Developer Interface
 ===================
 
-.. module:: octodns
-
 .. toctree::
    :maxdepth: 1
    :glob:

docs/api/cmds.rst

@@ -0,0 +1,11 @@
+Commands
+========
+
+.. autosummary::
+   :toctree: cmds
+
+   octodns.cmds.dump
+   octodns.cmds.report
+   octodns.cmds.sync
+   octodns.cmds.validate
+   octodns.cmds.versions

docs/api/helpers.rst

@@ -0,0 +1,11 @@
+Helpers
+=======
+
+.. autosummary::
+   :toctree: helpers
+
+   octodns.context
+   octodns.deprecation
+   octodns.equality
+   octodns.idna
+   octodns.yaml

docs/api/manager.rst

@@ -0,0 +1,5 @@
+Manager
+=======
+
+.. automodule::
+   octodns.manager

docs/api/provider-yaml.rst

@@ -1,5 +0,0 @@
-YamlProvider
-============
-
-.. automodule:: octodns.provider.yaml
-   :inherited-members:

docs/api/provider.rst

@@ -1,5 +0,0 @@
-Provider
-========
-
-.. automodule:: octodns.provider.base
-   :inherited-members:

docs/api/providers.rst

@@ -0,0 +1,9 @@
+Providers
+=========
+
+.. autosummary::
+   :toctree: providers
+
+   octodns.provider.base
+   octodns.provider.plan
+   octodns.provider.yaml

docs/api/secrets.rst

@@ -0,0 +1,9 @@
+Secrets
+=======
+
+.. autosummary::
+   :toctree: secrets
+
+   octodns.secret.base
+   octodns.secret.environ
+   octodns.secret.exception

docs/api/source.rst

@@ -1,5 +0,0 @@
-Source
-======
-
-.. automodule:: octodns.source.base
-   :inherited-members:

docs/api/sources.rst

@@ -0,0 +1,9 @@
+Sources
+=======
+
+.. autosummary::
+   :toctree: sources
+
+   octodns.source.base
+   octodns.source.envvar
+   octodns.source.tinydns

docs/api/zone.rst

@@ -0,0 +1,5 @@
+Zone
+====
+
+.. automodule::
+   octodns.zone

docs/configuration.rst

@@ -10,7 +10,7 @@ discussing details and less common scenarios.
 YamlProvider
 ------------
 
-:doc:`api/provider-yaml` lays out the options for configuring the most commonly
+:py:mod:`octodns.provider.yaml` lays out the options for configuring the most commonly
 used source of record data.
 
 Static Zone Config