From dc9e68e70e6784a33c43af9ba0da33a19cc3d006 Mon Sep 17 00:00:00 2001 From: Ross McFarland Date: Sun, 17 Aug 2025 15:30:50 -0700 Subject: [PATCH] Full doc coverage of the api and related cleanup --- .../5aab3287678b455f9644aa070a1e5457.md | 4 +++ .gitignore | 5 ++++ docs/api.rst | 2 -- docs/api/cmds.rst | 11 ++++++++ docs/api/helpers.rst | 11 ++++++++ docs/api/manager.rst | 5 ++++ docs/api/{processor.rst => processors.rst} | 26 +++++++++---------- docs/api/provider-yaml.rst | 5 ---- docs/api/provider.rst | 5 ---- docs/api/providers.rst | 9 +++++++ docs/api/secrets.rst | 9 +++++++ docs/api/source.rst | 5 ---- docs/api/sources.rst | 9 +++++++ docs/api/zone.rst | 5 ++++ docs/configuration.rst | 2 +- 15 files changed, 81 insertions(+), 32 deletions(-) create mode 100644 .changelog/5aab3287678b455f9644aa070a1e5457.md create mode 100644 docs/api/cmds.rst create mode 100644 docs/api/helpers.rst create mode 100644 docs/api/manager.rst rename docs/api/{processor.rst => processors.rst} (84%) delete mode 100644 docs/api/provider-yaml.rst delete mode 100644 docs/api/provider.rst create mode 100644 docs/api/providers.rst create mode 100644 docs/api/secrets.rst delete mode 100644 docs/api/source.rst create mode 100644 docs/api/sources.rst create mode 100644 docs/api/zone.rst diff --git a/.changelog/5aab3287678b455f9644aa070a1e5457.md b/.changelog/5aab3287678b455f9644aa070a1e5457.md new file mode 100644 index 0000000..e2065ca --- /dev/null +++ b/.changelog/5aab3287678b455f9644aa070a1e5457.md @@ -0,0 +1,4 @@ +--- +type: none +--- +Full doc coverage of the api and related cleanup \ No newline at end of file diff --git a/.gitignore b/.gitignore index 00ab29f..e87cd1c 100644 --- a/.gitignore +++ b/.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/ diff --git a/docs/api.rst b/docs/api.rst index a7092e4..16cd8b1 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -3,8 +3,6 @@ Developer Interface =================== -.. module:: octodns - .. toctree:: :maxdepth: 1 :glob: diff --git a/docs/api/cmds.rst b/docs/api/cmds.rst new file mode 100644 index 0000000..9a16569 --- /dev/null +++ b/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 diff --git a/docs/api/helpers.rst b/docs/api/helpers.rst new file mode 100644 index 0000000..057ca06 --- /dev/null +++ b/docs/api/helpers.rst @@ -0,0 +1,11 @@ +Helpers +======= + +.. autosummary:: + :toctree: helpers + + octodns.context + octodns.deprecation + octodns.equality + octodns.idna + octodns.yaml diff --git a/docs/api/manager.rst b/docs/api/manager.rst new file mode 100644 index 0000000..76c5c29 --- /dev/null +++ b/docs/api/manager.rst @@ -0,0 +1,5 @@ +Manager +======= + +.. automodule:: + octodns.manager diff --git a/docs/api/processor.rst b/docs/api/processors.rst similarity index 84% rename from docs/api/processor.rst rename to docs/api/processors.rst index e2e1f07..336f6e9 100644 --- a/docs/api/processor.rst +++ b/docs/api/processors.rst @@ -1,5 +1,5 @@ -Processor -========= +Processors +========== Defining a processor configuration ---------------------------------- @@ -55,18 +55,16 @@ domains added to the ``zones`` config in future then you can add this to the processors: - custom_meta -.. currentmodule:: octodns.processor - .. autosummary:: :toctree: processors - base - acme - arpa - filter - meta - ownership - restrict - spf - templating - trailing_dots + octodns.processor.base + octodns.processor.acme + octodns.processor.arpa + octodns.processor.filter + octodns.processor.meta + octodns.processor.ownership + octodns.processor.restrict + octodns.processor.spf + octodns.processor.templating + octodns.processor.trailing_dots diff --git a/docs/api/provider-yaml.rst b/docs/api/provider-yaml.rst deleted file mode 100644 index 771c80a..0000000 --- a/docs/api/provider-yaml.rst +++ /dev/null @@ -1,5 +0,0 @@ -YamlProvider -============ - -.. automodule:: octodns.provider.yaml - :inherited-members: diff --git a/docs/api/provider.rst b/docs/api/provider.rst deleted file mode 100644 index 04cf347..0000000 --- a/docs/api/provider.rst +++ /dev/null @@ -1,5 +0,0 @@ -Provider -======== - -.. automodule:: octodns.provider.base - :inherited-members: diff --git a/docs/api/providers.rst b/docs/api/providers.rst new file mode 100644 index 0000000..26b2cd2 --- /dev/null +++ b/docs/api/providers.rst @@ -0,0 +1,9 @@ +Providers +========= + +.. autosummary:: + :toctree: providers + + octodns.provider.base + octodns.provider.plan + octodns.provider.yaml diff --git a/docs/api/secrets.rst b/docs/api/secrets.rst new file mode 100644 index 0000000..5a192bb --- /dev/null +++ b/docs/api/secrets.rst @@ -0,0 +1,9 @@ +Secrets +======= + +.. autosummary:: + :toctree: secrets + + octodns.secret.base + octodns.secret.environ + octodns.secret.exception diff --git a/docs/api/source.rst b/docs/api/source.rst deleted file mode 100644 index e7cf90c..0000000 --- a/docs/api/source.rst +++ /dev/null @@ -1,5 +0,0 @@ -Source -====== - -.. automodule:: octodns.source.base - :inherited-members: diff --git a/docs/api/sources.rst b/docs/api/sources.rst new file mode 100644 index 0000000..20db360 --- /dev/null +++ b/docs/api/sources.rst @@ -0,0 +1,9 @@ +Sources +======= + +.. autosummary:: + :toctree: sources + + octodns.source.base + octodns.source.envvar + octodns.source.tinydns diff --git a/docs/api/zone.rst b/docs/api/zone.rst new file mode 100644 index 0000000..8b0d124 --- /dev/null +++ b/docs/api/zone.rst @@ -0,0 +1,5 @@ +Zone +==== + +.. automodule:: + octodns.zone diff --git a/docs/configuration.rst b/docs/configuration.rst index a02eda7..08b3647 100644 --- a/docs/configuration.rst +++ b/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