From ce11aa3fdb4a45971b57cebac543b73b720addfe Mon Sep 17 00:00:00 2001 From: Ivan Schaller Date: Fri, 13 Jun 2025 12:51:00 +0200 Subject: [PATCH] Add initial sphinx docs Signed-off-by: Ivan Schaller --- .gitignore | 1 + docs/build_docs.sh | 6 ++ docs/conf.py | 90 +++++++++++++++++++ docs/get_docs.py | 28 ++++++ docs/index.md | 74 +++++++++++++++ docs/infos/changelog.md | 5 ++ docs/infos/license.md | 5 ++ docs/modules/cmds/octodns.cmds.args.rst | 5 ++ docs/modules/cmds/octodns.cmds.compare.rst | 5 ++ docs/modules/cmds/octodns.cmds.dump.rst | 5 ++ docs/modules/cmds/octodns.cmds.report.rst | 5 ++ docs/modules/cmds/octodns.cmds.sync.rst | 5 ++ docs/modules/cmds/octodns.cmds.validate.rst | 5 ++ docs/modules/cmds/octodns.cmds.versions.rst | 5 ++ docs/modules/octodns.context.rst | 5 ++ docs/modules/octodns.deprecation.rst | 5 ++ docs/modules/octodns.equality.rst | 5 ++ docs/modules/octodns.idna.rst | 5 ++ docs/modules/octodns.manager.rst | 5 ++ docs/modules/octodns.yaml.rst | 5 ++ docs/modules/octodns.zone.rst | 5 ++ .../processor/octodns.processor.acme.rst | 5 ++ .../processor/octodns.processor.arpa.rst | 5 ++ .../processor/octodns.processor.base.rst | 5 ++ .../processor/octodns.processor.filter.rst | 5 ++ .../processor/octodns.processor.meta.rst | 5 ++ .../processor/octodns.processor.ownership.rst | 5 ++ .../processor/octodns.processor.restrict.rst | 5 ++ .../processor/octodns.processor.spf.rst | 5 ++ .../octodns.processor.trailing_dots.rst | 5 ++ .../provider/octodns.provider.base.rst | 5 ++ .../provider/octodns.provider.plan.rst | 5 ++ .../provider/octodns.provider.yaml.rst | 5 ++ docs/modules/record/octodns.record.a.rst | 5 ++ docs/modules/record/octodns.record.aaaa.rst | 5 ++ docs/modules/record/octodns.record.alias.rst | 5 ++ docs/modules/record/octodns.record.base.rst | 5 ++ docs/modules/record/octodns.record.caa.rst | 5 ++ docs/modules/record/octodns.record.change.rst | 5 ++ .../modules/record/octodns.record.chunked.rst | 5 ++ docs/modules/record/octodns.record.cname.rst | 5 ++ docs/modules/record/octodns.record.dname.rst | 5 ++ docs/modules/record/octodns.record.ds.rst | 5 ++ .../modules/record/octodns.record.dynamic.rst | 5 ++ .../record/octodns.record.exception.rst | 5 ++ docs/modules/record/octodns.record.geo.rst | 5 ++ .../record/octodns.record.geo_data.rst | 5 ++ docs/modules/record/octodns.record.https.rst | 5 ++ docs/modules/record/octodns.record.ip.rst | 5 ++ docs/modules/record/octodns.record.loc.rst | 5 ++ docs/modules/record/octodns.record.mx.rst | 5 ++ docs/modules/record/octodns.record.naptr.rst | 5 ++ docs/modules/record/octodns.record.ns.rst | 5 ++ docs/modules/record/octodns.record.ptr.rst | 5 ++ docs/modules/record/octodns.record.rr.rst | 5 ++ docs/modules/record/octodns.record.spf.rst | 5 ++ docs/modules/record/octodns.record.srv.rst | 5 ++ docs/modules/record/octodns.record.sshfp.rst | 5 ++ docs/modules/record/octodns.record.subnet.rst | 5 ++ docs/modules/record/octodns.record.svcb.rst | 5 ++ docs/modules/record/octodns.record.target.rst | 5 ++ docs/modules/record/octodns.record.tlsa.rst | 5 ++ docs/modules/record/octodns.record.txt.rst | 5 ++ docs/modules/record/octodns.record.urlfwd.rst | 5 ++ docs/modules/secret/octodns.secret.base.rst | 5 ++ .../modules/secret/octodns.secret.environ.rst | 5 ++ .../secret/octodns.secret.exception.rst | 5 ++ docs/modules/source/octodns.source.base.rst | 5 ++ docs/modules/source/octodns.source.envvar.rst | 5 ++ .../modules/source/octodns.source.tinydns.rst | 5 ++ docs/{ => pages}/auto_arpa.md | 0 docs/{ => pages}/dynamic_records.md | 0 docs/{ => pages}/geo_records.md | 0 docs/pages/quick-start.md | 6 ++ docs/{ => pages}/records.md | 0 75 files changed, 530 insertions(+) create mode 100644 docs/build_docs.sh create mode 100644 docs/conf.py create mode 100644 docs/get_docs.py create mode 100644 docs/index.md create mode 100644 docs/infos/changelog.md create mode 100644 docs/infos/license.md create mode 100644 docs/modules/cmds/octodns.cmds.args.rst create mode 100644 docs/modules/cmds/octodns.cmds.compare.rst create mode 100644 docs/modules/cmds/octodns.cmds.dump.rst create mode 100644 docs/modules/cmds/octodns.cmds.report.rst create mode 100644 docs/modules/cmds/octodns.cmds.sync.rst create mode 100644 docs/modules/cmds/octodns.cmds.validate.rst create mode 100644 docs/modules/cmds/octodns.cmds.versions.rst create mode 100644 docs/modules/octodns.context.rst create mode 100644 docs/modules/octodns.deprecation.rst create mode 100644 docs/modules/octodns.equality.rst create mode 100644 docs/modules/octodns.idna.rst create mode 100644 docs/modules/octodns.manager.rst create mode 100644 docs/modules/octodns.yaml.rst create mode 100644 docs/modules/octodns.zone.rst create mode 100644 docs/modules/processor/octodns.processor.acme.rst create mode 100644 docs/modules/processor/octodns.processor.arpa.rst create mode 100644 docs/modules/processor/octodns.processor.base.rst create mode 100644 docs/modules/processor/octodns.processor.filter.rst create mode 100644 docs/modules/processor/octodns.processor.meta.rst create mode 100644 docs/modules/processor/octodns.processor.ownership.rst create mode 100644 docs/modules/processor/octodns.processor.restrict.rst create mode 100644 docs/modules/processor/octodns.processor.spf.rst create mode 100644 docs/modules/processor/octodns.processor.trailing_dots.rst create mode 100644 docs/modules/provider/octodns.provider.base.rst create mode 100644 docs/modules/provider/octodns.provider.plan.rst create mode 100644 docs/modules/provider/octodns.provider.yaml.rst create mode 100644 docs/modules/record/octodns.record.a.rst create mode 100644 docs/modules/record/octodns.record.aaaa.rst create mode 100644 docs/modules/record/octodns.record.alias.rst create mode 100644 docs/modules/record/octodns.record.base.rst create mode 100644 docs/modules/record/octodns.record.caa.rst create mode 100644 docs/modules/record/octodns.record.change.rst create mode 100644 docs/modules/record/octodns.record.chunked.rst create mode 100644 docs/modules/record/octodns.record.cname.rst create mode 100644 docs/modules/record/octodns.record.dname.rst create mode 100644 docs/modules/record/octodns.record.ds.rst create mode 100644 docs/modules/record/octodns.record.dynamic.rst create mode 100644 docs/modules/record/octodns.record.exception.rst create mode 100644 docs/modules/record/octodns.record.geo.rst create mode 100644 docs/modules/record/octodns.record.geo_data.rst create mode 100644 docs/modules/record/octodns.record.https.rst create mode 100644 docs/modules/record/octodns.record.ip.rst create mode 100644 docs/modules/record/octodns.record.loc.rst create mode 100644 docs/modules/record/octodns.record.mx.rst create mode 100644 docs/modules/record/octodns.record.naptr.rst create mode 100644 docs/modules/record/octodns.record.ns.rst create mode 100644 docs/modules/record/octodns.record.ptr.rst create mode 100644 docs/modules/record/octodns.record.rr.rst create mode 100644 docs/modules/record/octodns.record.spf.rst create mode 100644 docs/modules/record/octodns.record.srv.rst create mode 100644 docs/modules/record/octodns.record.sshfp.rst create mode 100644 docs/modules/record/octodns.record.subnet.rst create mode 100644 docs/modules/record/octodns.record.svcb.rst create mode 100644 docs/modules/record/octodns.record.target.rst create mode 100644 docs/modules/record/octodns.record.tlsa.rst create mode 100644 docs/modules/record/octodns.record.txt.rst create mode 100644 docs/modules/record/octodns.record.urlfwd.rst create mode 100644 docs/modules/secret/octodns.secret.base.rst create mode 100644 docs/modules/secret/octodns.secret.environ.rst create mode 100644 docs/modules/secret/octodns.secret.exception.rst create mode 100644 docs/modules/source/octodns.source.base.rst create mode 100644 docs/modules/source/octodns.source.envvar.rst create mode 100644 docs/modules/source/octodns.source.tinydns.rst rename docs/{ => pages}/auto_arpa.md (100%) rename docs/{ => pages}/dynamic_records.md (100%) rename docs/{ => pages}/geo_records.md (100%) create mode 100644 docs/pages/quick-start.md rename docs/{ => pages}/records.md (100%) diff --git a/.gitignore b/.gitignore index 8bf8edf..d050ac0 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ octodns.egg-info/ output/ tests/zones/unit.tests. tmp/ +docs/_build/ diff --git a/docs/build_docs.sh b/docs/build_docs.sh new file mode 100644 index 0000000..bd10a78 --- /dev/null +++ b/docs/build_docs.sh @@ -0,0 +1,6 @@ +#!/usr/bin/env bash + +set -xeuo pipefail + +rm -rf docs/_build +sphinx-build -M html docs docs/_build "${@}" diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..f20ee6c --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,90 @@ +import sys +from pathlib import Path + +sys.path.insert(0, str(Path("..", "src").resolve())) + +from octodns.__init__ import __version__ + +### sphinx config ### + +project = "octodns" +copyright = "2017-present" # noqa +author = "Ross McFarland" +release = __version__ + +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.viewcode", + "myst_parser", + "sphinx_copybutton", +] + + +### autodoc ### + +autodoc_default_options = { + "members": True, + "undoc-members": True, + "private-members": False, + "special-members": "__init__", + "show-inheritance": True, + "exclude-members": "__weakref__", +} +autodoc_typehints = "both" +autodoc_typehints_description_target = "all" +autodoc_member_order = "alphabetical" + +### extlinks ### + +extlinks = { + "github": ("https://github.com/%s", "%s"), + "pypi": ("https://pypi.org/project/%s/", "%s"), +} +extlinks_detect_hardcoded_links = True + + +### intersphinx ### + +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), + "sphinx": ("https://www.sphinx-doc.org/en/master", None), + "dnspython": ("https://dnspython.readthedocs.io/en/stable/", None), +} + + +### todo ### + +todo_include_todos = True + + +### myst ### + +myst_enable_extensions = [ + "colon_fence", + "deflist", +] +myst_heading_anchors = 3 + + +### content ### + +master_doc = "index" + +templates_path = ["_templates"] +html_static_path = ["_static"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + + +### theme ### + +# tml_theme = "alabaster" +html_theme = "furo" +html_theme_options = { + "source_repository": "https://github.com/octodns/octodns/", + "source_branch": "main", + "source_directory": "docs/", +} diff --git a/docs/get_docs.py b/docs/get_docs.py new file mode 100644 index 0000000..0ef6781 --- /dev/null +++ b/docs/get_docs.py @@ -0,0 +1,28 @@ +from pathlib import Path + +SRCDIR = Path("octodns") +DOC_MODULE_DIR = Path("docs/modules") + +DOC_MODULE_TEMPLATE = """ +==================================== +``{module_name}`` +==================================== + +.. automodule:: {module_name}""" + +for module in SRCDIR.rglob("*.py"): + if module.name in ["__init__.py", "__about__.py"]: + continue + + module_docname = str(module).replace("/", ".").removesuffix(".py") + + if module.parent.name != "octodns": + module_docpath = DOC_MODULE_DIR / module.parent.name / f"{module_docname}.rst" + else: + module_docpath = DOC_MODULE_DIR / f"{module_docname}.rst" + + print(f"creating sphinx doc module for: {module_docname}") + module_docpath.parent.mkdir(exist_ok=True, parents=True) + module_docpath.write_text( + DOC_MODULE_TEMPLATE.format(module_name=module_docname).strip() + ) diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..436bf1c --- /dev/null +++ b/docs/index.md @@ -0,0 +1,74 @@ +# octodns documentation + +```{include} ../README.md +:end-before: "## Table of Contents" +``` + +--- + +## Indices and tables + +- {ref}`genindex` +- {ref}`modindex` + +### Project infos + +- [License](infos/license.md) +- [Changelog](infos/changelog.md) + +--- + +## User documentation + +```{toctree} +:caption: Guides: +:maxdepth: 1 +:glob: + +``` + +--- + +## Module documentation + +```{toctree} +:caption: Processors: +:maxdepth: 2 +:glob: + +modules/processor/* +``` + +```{toctree} +:caption: Providers: +:maxdepth: 2 +:glob: + +modules/provider/* +``` + +```{toctree} +:caption: Sources: +:maxdepth: 2 +:glob: + +modules/source/* +``` + +```{toctree} +:caption: Records: +:maxdepth: 2 +:glob: + +modules/record/* +``` + +```{toctree} +:caption: Other modules: +:titlesonly: +:glob: + +modules/* +modules/cmds/* +modules/secret/* +``` diff --git a/docs/infos/changelog.md b/docs/infos/changelog.md new file mode 100644 index 0000000..d108f58 --- /dev/null +++ b/docs/infos/changelog.md @@ -0,0 +1,5 @@ +# Changelog + +```{include} ../../CHANGELOG.md + +``` diff --git a/docs/infos/license.md b/docs/infos/license.md new file mode 100644 index 0000000..eef79d3 --- /dev/null +++ b/docs/infos/license.md @@ -0,0 +1,5 @@ +# License + +```{include} ../../LICENSE + +``` diff --git a/docs/modules/cmds/octodns.cmds.args.rst b/docs/modules/cmds/octodns.cmds.args.rst new file mode 100644 index 0000000..4a4697a --- /dev/null +++ b/docs/modules/cmds/octodns.cmds.args.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.cmds.args`` +==================================== + +.. automodule:: octodns.cmds.args \ No newline at end of file diff --git a/docs/modules/cmds/octodns.cmds.compare.rst b/docs/modules/cmds/octodns.cmds.compare.rst new file mode 100644 index 0000000..049015b --- /dev/null +++ b/docs/modules/cmds/octodns.cmds.compare.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.cmds.compare`` +==================================== + +.. automodule:: octodns.cmds.compare \ No newline at end of file diff --git a/docs/modules/cmds/octodns.cmds.dump.rst b/docs/modules/cmds/octodns.cmds.dump.rst new file mode 100644 index 0000000..9ef7941 --- /dev/null +++ b/docs/modules/cmds/octodns.cmds.dump.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.cmds.dump`` +==================================== + +.. automodule:: octodns.cmds.dump \ No newline at end of file diff --git a/docs/modules/cmds/octodns.cmds.report.rst b/docs/modules/cmds/octodns.cmds.report.rst new file mode 100644 index 0000000..1e08379 --- /dev/null +++ b/docs/modules/cmds/octodns.cmds.report.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.cmds.report`` +==================================== + +.. automodule:: octodns.cmds.report \ No newline at end of file diff --git a/docs/modules/cmds/octodns.cmds.sync.rst b/docs/modules/cmds/octodns.cmds.sync.rst new file mode 100644 index 0000000..e20f6df --- /dev/null +++ b/docs/modules/cmds/octodns.cmds.sync.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.cmds.sync`` +==================================== + +.. automodule:: octodns.cmds.sync \ No newline at end of file diff --git a/docs/modules/cmds/octodns.cmds.validate.rst b/docs/modules/cmds/octodns.cmds.validate.rst new file mode 100644 index 0000000..254c9f7 --- /dev/null +++ b/docs/modules/cmds/octodns.cmds.validate.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.cmds.validate`` +==================================== + +.. automodule:: octodns.cmds.validate \ No newline at end of file diff --git a/docs/modules/cmds/octodns.cmds.versions.rst b/docs/modules/cmds/octodns.cmds.versions.rst new file mode 100644 index 0000000..4e52999 --- /dev/null +++ b/docs/modules/cmds/octodns.cmds.versions.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.cmds.versions`` +==================================== + +.. automodule:: octodns.cmds.versions \ No newline at end of file diff --git a/docs/modules/octodns.context.rst b/docs/modules/octodns.context.rst new file mode 100644 index 0000000..bfaf0b4 --- /dev/null +++ b/docs/modules/octodns.context.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.context`` +==================================== + +.. automodule:: octodns.context \ No newline at end of file diff --git a/docs/modules/octodns.deprecation.rst b/docs/modules/octodns.deprecation.rst new file mode 100644 index 0000000..2db5b50 --- /dev/null +++ b/docs/modules/octodns.deprecation.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.deprecation`` +==================================== + +.. automodule:: octodns.deprecation \ No newline at end of file diff --git a/docs/modules/octodns.equality.rst b/docs/modules/octodns.equality.rst new file mode 100644 index 0000000..ae9c9b6 --- /dev/null +++ b/docs/modules/octodns.equality.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.equality`` +==================================== + +.. automodule:: octodns.equality \ No newline at end of file diff --git a/docs/modules/octodns.idna.rst b/docs/modules/octodns.idna.rst new file mode 100644 index 0000000..1361a97 --- /dev/null +++ b/docs/modules/octodns.idna.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.idna`` +==================================== + +.. automodule:: octodns.idna \ No newline at end of file diff --git a/docs/modules/octodns.manager.rst b/docs/modules/octodns.manager.rst new file mode 100644 index 0000000..cf30fee --- /dev/null +++ b/docs/modules/octodns.manager.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.manager`` +==================================== + +.. automodule:: octodns.manager \ No newline at end of file diff --git a/docs/modules/octodns.yaml.rst b/docs/modules/octodns.yaml.rst new file mode 100644 index 0000000..c545263 --- /dev/null +++ b/docs/modules/octodns.yaml.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.yaml`` +==================================== + +.. automodule:: octodns.yaml \ No newline at end of file diff --git a/docs/modules/octodns.zone.rst b/docs/modules/octodns.zone.rst new file mode 100644 index 0000000..bf7a738 --- /dev/null +++ b/docs/modules/octodns.zone.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.zone`` +==================================== + +.. automodule:: octodns.zone \ No newline at end of file diff --git a/docs/modules/processor/octodns.processor.acme.rst b/docs/modules/processor/octodns.processor.acme.rst new file mode 100644 index 0000000..93a8cae --- /dev/null +++ b/docs/modules/processor/octodns.processor.acme.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.processor.acme`` +==================================== + +.. automodule:: octodns.processor.acme \ No newline at end of file diff --git a/docs/modules/processor/octodns.processor.arpa.rst b/docs/modules/processor/octodns.processor.arpa.rst new file mode 100644 index 0000000..6757eca --- /dev/null +++ b/docs/modules/processor/octodns.processor.arpa.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.processor.arpa`` +==================================== + +.. automodule:: octodns.processor.arpa \ No newline at end of file diff --git a/docs/modules/processor/octodns.processor.base.rst b/docs/modules/processor/octodns.processor.base.rst new file mode 100644 index 0000000..2603b97 --- /dev/null +++ b/docs/modules/processor/octodns.processor.base.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.processor.base`` +==================================== + +.. automodule:: octodns.processor.base \ No newline at end of file diff --git a/docs/modules/processor/octodns.processor.filter.rst b/docs/modules/processor/octodns.processor.filter.rst new file mode 100644 index 0000000..e2f3139 --- /dev/null +++ b/docs/modules/processor/octodns.processor.filter.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.processor.filter`` +==================================== + +.. automodule:: octodns.processor.filter \ No newline at end of file diff --git a/docs/modules/processor/octodns.processor.meta.rst b/docs/modules/processor/octodns.processor.meta.rst new file mode 100644 index 0000000..89be8bc --- /dev/null +++ b/docs/modules/processor/octodns.processor.meta.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.processor.meta`` +==================================== + +.. automodule:: octodns.processor.meta \ No newline at end of file diff --git a/docs/modules/processor/octodns.processor.ownership.rst b/docs/modules/processor/octodns.processor.ownership.rst new file mode 100644 index 0000000..9d4f6fe --- /dev/null +++ b/docs/modules/processor/octodns.processor.ownership.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.processor.ownership`` +==================================== + +.. automodule:: octodns.processor.ownership \ No newline at end of file diff --git a/docs/modules/processor/octodns.processor.restrict.rst b/docs/modules/processor/octodns.processor.restrict.rst new file mode 100644 index 0000000..5f801b2 --- /dev/null +++ b/docs/modules/processor/octodns.processor.restrict.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.processor.restrict`` +==================================== + +.. automodule:: octodns.processor.restrict \ No newline at end of file diff --git a/docs/modules/processor/octodns.processor.spf.rst b/docs/modules/processor/octodns.processor.spf.rst new file mode 100644 index 0000000..4da6a78 --- /dev/null +++ b/docs/modules/processor/octodns.processor.spf.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.processor.spf`` +==================================== + +.. automodule:: octodns.processor.spf \ No newline at end of file diff --git a/docs/modules/processor/octodns.processor.trailing_dots.rst b/docs/modules/processor/octodns.processor.trailing_dots.rst new file mode 100644 index 0000000..1135e7c --- /dev/null +++ b/docs/modules/processor/octodns.processor.trailing_dots.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.processor.trailing_dots`` +==================================== + +.. automodule:: octodns.processor.trailing_dots \ No newline at end of file diff --git a/docs/modules/provider/octodns.provider.base.rst b/docs/modules/provider/octodns.provider.base.rst new file mode 100644 index 0000000..24e9080 --- /dev/null +++ b/docs/modules/provider/octodns.provider.base.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.provider.base`` +==================================== + +.. automodule:: octodns.provider.base \ No newline at end of file diff --git a/docs/modules/provider/octodns.provider.plan.rst b/docs/modules/provider/octodns.provider.plan.rst new file mode 100644 index 0000000..e94c4c8 --- /dev/null +++ b/docs/modules/provider/octodns.provider.plan.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.provider.plan`` +==================================== + +.. automodule:: octodns.provider.plan \ No newline at end of file diff --git a/docs/modules/provider/octodns.provider.yaml.rst b/docs/modules/provider/octodns.provider.yaml.rst new file mode 100644 index 0000000..c77b734 --- /dev/null +++ b/docs/modules/provider/octodns.provider.yaml.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.provider.yaml`` +==================================== + +.. automodule:: octodns.provider.yaml \ No newline at end of file diff --git a/docs/modules/record/octodns.record.a.rst b/docs/modules/record/octodns.record.a.rst new file mode 100644 index 0000000..5d0d472 --- /dev/null +++ b/docs/modules/record/octodns.record.a.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.a`` +==================================== + +.. automodule:: octodns.record.a \ No newline at end of file diff --git a/docs/modules/record/octodns.record.aaaa.rst b/docs/modules/record/octodns.record.aaaa.rst new file mode 100644 index 0000000..e76e0e9 --- /dev/null +++ b/docs/modules/record/octodns.record.aaaa.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.aaaa`` +==================================== + +.. automodule:: octodns.record.aaaa \ No newline at end of file diff --git a/docs/modules/record/octodns.record.alias.rst b/docs/modules/record/octodns.record.alias.rst new file mode 100644 index 0000000..54fbb72 --- /dev/null +++ b/docs/modules/record/octodns.record.alias.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.alias`` +==================================== + +.. automodule:: octodns.record.alias \ No newline at end of file diff --git a/docs/modules/record/octodns.record.base.rst b/docs/modules/record/octodns.record.base.rst new file mode 100644 index 0000000..c79d7d6 --- /dev/null +++ b/docs/modules/record/octodns.record.base.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.base`` +==================================== + +.. automodule:: octodns.record.base \ No newline at end of file diff --git a/docs/modules/record/octodns.record.caa.rst b/docs/modules/record/octodns.record.caa.rst new file mode 100644 index 0000000..6cb3b49 --- /dev/null +++ b/docs/modules/record/octodns.record.caa.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.caa`` +==================================== + +.. automodule:: octodns.record.caa \ No newline at end of file diff --git a/docs/modules/record/octodns.record.change.rst b/docs/modules/record/octodns.record.change.rst new file mode 100644 index 0000000..5b29644 --- /dev/null +++ b/docs/modules/record/octodns.record.change.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.change`` +==================================== + +.. automodule:: octodns.record.change \ No newline at end of file diff --git a/docs/modules/record/octodns.record.chunked.rst b/docs/modules/record/octodns.record.chunked.rst new file mode 100644 index 0000000..8b78522 --- /dev/null +++ b/docs/modules/record/octodns.record.chunked.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.chunked`` +==================================== + +.. automodule:: octodns.record.chunked \ No newline at end of file diff --git a/docs/modules/record/octodns.record.cname.rst b/docs/modules/record/octodns.record.cname.rst new file mode 100644 index 0000000..e901423 --- /dev/null +++ b/docs/modules/record/octodns.record.cname.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.cname`` +==================================== + +.. automodule:: octodns.record.cname \ No newline at end of file diff --git a/docs/modules/record/octodns.record.dname.rst b/docs/modules/record/octodns.record.dname.rst new file mode 100644 index 0000000..0368901 --- /dev/null +++ b/docs/modules/record/octodns.record.dname.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.dname`` +==================================== + +.. automodule:: octodns.record.dname \ No newline at end of file diff --git a/docs/modules/record/octodns.record.ds.rst b/docs/modules/record/octodns.record.ds.rst new file mode 100644 index 0000000..24bb79f --- /dev/null +++ b/docs/modules/record/octodns.record.ds.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.ds`` +==================================== + +.. automodule:: octodns.record.ds \ No newline at end of file diff --git a/docs/modules/record/octodns.record.dynamic.rst b/docs/modules/record/octodns.record.dynamic.rst new file mode 100644 index 0000000..f125167 --- /dev/null +++ b/docs/modules/record/octodns.record.dynamic.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.dynamic`` +==================================== + +.. automodule:: octodns.record.dynamic \ No newline at end of file diff --git a/docs/modules/record/octodns.record.exception.rst b/docs/modules/record/octodns.record.exception.rst new file mode 100644 index 0000000..7cac538 --- /dev/null +++ b/docs/modules/record/octodns.record.exception.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.exception`` +==================================== + +.. automodule:: octodns.record.exception \ No newline at end of file diff --git a/docs/modules/record/octodns.record.geo.rst b/docs/modules/record/octodns.record.geo.rst new file mode 100644 index 0000000..bbce790 --- /dev/null +++ b/docs/modules/record/octodns.record.geo.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.geo`` +==================================== + +.. automodule:: octodns.record.geo \ No newline at end of file diff --git a/docs/modules/record/octodns.record.geo_data.rst b/docs/modules/record/octodns.record.geo_data.rst new file mode 100644 index 0000000..082bc44 --- /dev/null +++ b/docs/modules/record/octodns.record.geo_data.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.geo_data`` +==================================== + +.. automodule:: octodns.record.geo_data \ No newline at end of file diff --git a/docs/modules/record/octodns.record.https.rst b/docs/modules/record/octodns.record.https.rst new file mode 100644 index 0000000..65dd2f1 --- /dev/null +++ b/docs/modules/record/octodns.record.https.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.https`` +==================================== + +.. automodule:: octodns.record.https \ No newline at end of file diff --git a/docs/modules/record/octodns.record.ip.rst b/docs/modules/record/octodns.record.ip.rst new file mode 100644 index 0000000..46f4f11 --- /dev/null +++ b/docs/modules/record/octodns.record.ip.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.ip`` +==================================== + +.. automodule:: octodns.record.ip \ No newline at end of file diff --git a/docs/modules/record/octodns.record.loc.rst b/docs/modules/record/octodns.record.loc.rst new file mode 100644 index 0000000..49f8639 --- /dev/null +++ b/docs/modules/record/octodns.record.loc.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.loc`` +==================================== + +.. automodule:: octodns.record.loc \ No newline at end of file diff --git a/docs/modules/record/octodns.record.mx.rst b/docs/modules/record/octodns.record.mx.rst new file mode 100644 index 0000000..eb554d2 --- /dev/null +++ b/docs/modules/record/octodns.record.mx.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.mx`` +==================================== + +.. automodule:: octodns.record.mx \ No newline at end of file diff --git a/docs/modules/record/octodns.record.naptr.rst b/docs/modules/record/octodns.record.naptr.rst new file mode 100644 index 0000000..73ba49e --- /dev/null +++ b/docs/modules/record/octodns.record.naptr.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.naptr`` +==================================== + +.. automodule:: octodns.record.naptr \ No newline at end of file diff --git a/docs/modules/record/octodns.record.ns.rst b/docs/modules/record/octodns.record.ns.rst new file mode 100644 index 0000000..44233fc --- /dev/null +++ b/docs/modules/record/octodns.record.ns.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.ns`` +==================================== + +.. automodule:: octodns.record.ns \ No newline at end of file diff --git a/docs/modules/record/octodns.record.ptr.rst b/docs/modules/record/octodns.record.ptr.rst new file mode 100644 index 0000000..ba3ca3d --- /dev/null +++ b/docs/modules/record/octodns.record.ptr.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.ptr`` +==================================== + +.. automodule:: octodns.record.ptr \ No newline at end of file diff --git a/docs/modules/record/octodns.record.rr.rst b/docs/modules/record/octodns.record.rr.rst new file mode 100644 index 0000000..469c316 --- /dev/null +++ b/docs/modules/record/octodns.record.rr.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.rr`` +==================================== + +.. automodule:: octodns.record.rr \ No newline at end of file diff --git a/docs/modules/record/octodns.record.spf.rst b/docs/modules/record/octodns.record.spf.rst new file mode 100644 index 0000000..97c163d --- /dev/null +++ b/docs/modules/record/octodns.record.spf.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.spf`` +==================================== + +.. automodule:: octodns.record.spf \ No newline at end of file diff --git a/docs/modules/record/octodns.record.srv.rst b/docs/modules/record/octodns.record.srv.rst new file mode 100644 index 0000000..394520a --- /dev/null +++ b/docs/modules/record/octodns.record.srv.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.srv`` +==================================== + +.. automodule:: octodns.record.srv \ No newline at end of file diff --git a/docs/modules/record/octodns.record.sshfp.rst b/docs/modules/record/octodns.record.sshfp.rst new file mode 100644 index 0000000..0c828cb --- /dev/null +++ b/docs/modules/record/octodns.record.sshfp.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.sshfp`` +==================================== + +.. automodule:: octodns.record.sshfp \ No newline at end of file diff --git a/docs/modules/record/octodns.record.subnet.rst b/docs/modules/record/octodns.record.subnet.rst new file mode 100644 index 0000000..46caf98 --- /dev/null +++ b/docs/modules/record/octodns.record.subnet.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.subnet`` +==================================== + +.. automodule:: octodns.record.subnet \ No newline at end of file diff --git a/docs/modules/record/octodns.record.svcb.rst b/docs/modules/record/octodns.record.svcb.rst new file mode 100644 index 0000000..9e43ebf --- /dev/null +++ b/docs/modules/record/octodns.record.svcb.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.svcb`` +==================================== + +.. automodule:: octodns.record.svcb \ No newline at end of file diff --git a/docs/modules/record/octodns.record.target.rst b/docs/modules/record/octodns.record.target.rst new file mode 100644 index 0000000..a69a81d --- /dev/null +++ b/docs/modules/record/octodns.record.target.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.target`` +==================================== + +.. automodule:: octodns.record.target \ No newline at end of file diff --git a/docs/modules/record/octodns.record.tlsa.rst b/docs/modules/record/octodns.record.tlsa.rst new file mode 100644 index 0000000..b1c30c3 --- /dev/null +++ b/docs/modules/record/octodns.record.tlsa.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.tlsa`` +==================================== + +.. automodule:: octodns.record.tlsa \ No newline at end of file diff --git a/docs/modules/record/octodns.record.txt.rst b/docs/modules/record/octodns.record.txt.rst new file mode 100644 index 0000000..69df775 --- /dev/null +++ b/docs/modules/record/octodns.record.txt.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.txt`` +==================================== + +.. automodule:: octodns.record.txt \ No newline at end of file diff --git a/docs/modules/record/octodns.record.urlfwd.rst b/docs/modules/record/octodns.record.urlfwd.rst new file mode 100644 index 0000000..e72d909 --- /dev/null +++ b/docs/modules/record/octodns.record.urlfwd.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.record.urlfwd`` +==================================== + +.. automodule:: octodns.record.urlfwd \ No newline at end of file diff --git a/docs/modules/secret/octodns.secret.base.rst b/docs/modules/secret/octodns.secret.base.rst new file mode 100644 index 0000000..c3b654b --- /dev/null +++ b/docs/modules/secret/octodns.secret.base.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.secret.base`` +==================================== + +.. automodule:: octodns.secret.base \ No newline at end of file diff --git a/docs/modules/secret/octodns.secret.environ.rst b/docs/modules/secret/octodns.secret.environ.rst new file mode 100644 index 0000000..fe2f86d --- /dev/null +++ b/docs/modules/secret/octodns.secret.environ.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.secret.environ`` +==================================== + +.. automodule:: octodns.secret.environ \ No newline at end of file diff --git a/docs/modules/secret/octodns.secret.exception.rst b/docs/modules/secret/octodns.secret.exception.rst new file mode 100644 index 0000000..cd95938 --- /dev/null +++ b/docs/modules/secret/octodns.secret.exception.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.secret.exception`` +==================================== + +.. automodule:: octodns.secret.exception \ No newline at end of file diff --git a/docs/modules/source/octodns.source.base.rst b/docs/modules/source/octodns.source.base.rst new file mode 100644 index 0000000..7af2f1e --- /dev/null +++ b/docs/modules/source/octodns.source.base.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.source.base`` +==================================== + +.. automodule:: octodns.source.base \ No newline at end of file diff --git a/docs/modules/source/octodns.source.envvar.rst b/docs/modules/source/octodns.source.envvar.rst new file mode 100644 index 0000000..95822ba --- /dev/null +++ b/docs/modules/source/octodns.source.envvar.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.source.envvar`` +==================================== + +.. automodule:: octodns.source.envvar \ No newline at end of file diff --git a/docs/modules/source/octodns.source.tinydns.rst b/docs/modules/source/octodns.source.tinydns.rst new file mode 100644 index 0000000..35c69bb --- /dev/null +++ b/docs/modules/source/octodns.source.tinydns.rst @@ -0,0 +1,5 @@ +==================================== +``octodns.source.tinydns`` +==================================== + +.. automodule:: octodns.source.tinydns \ No newline at end of file diff --git a/docs/auto_arpa.md b/docs/pages/auto_arpa.md similarity index 100% rename from docs/auto_arpa.md rename to docs/pages/auto_arpa.md diff --git a/docs/dynamic_records.md b/docs/pages/dynamic_records.md similarity index 100% rename from docs/dynamic_records.md rename to docs/pages/dynamic_records.md diff --git a/docs/geo_records.md b/docs/pages/geo_records.md similarity index 100% rename from docs/geo_records.md rename to docs/pages/geo_records.md diff --git a/docs/pages/quick-start.md b/docs/pages/quick-start.md new file mode 100644 index 0000000..8f72687 --- /dev/null +++ b/docs/pages/quick-start.md @@ -0,0 +1,6 @@ +# Quick-Start + +```{include} ../../README.md +:start-after: "## Getting started" +:end-before: "## Providers" +``` diff --git a/docs/records.md b/docs/pages/records.md similarity index 100% rename from docs/records.md rename to docs/pages/records.md