diff --git a/CHANGELOG.md b/CHANGELOG.md index eff5631..a10e604 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -175,8 +175,7 @@ Minor: ### Noteworthy changes * New dynamic zone config support that allows wildcard entries in the octoDNS - config to be expanded by the source provider(s). See - [Dynamic Zone Config](/README.md#dynamic-zone-config) for more information. + config to be expanded by the source provider(s). * SplitYamlProvider has been deprecated and will be removed in 2.0. YamlProvider now includes the ability to process split zones when configured to do so and allows for more flexibility in how things are laid out than was previously @@ -254,11 +253,8 @@ long (years) overdue. from octodns.record you'll need to update and pull them from their actual home. Classes beginning with _ are not exported from octodns.record any longer as they were considered private/protected. -* Beta support for auto-arpa has been added, See the - [auto-arpa documentation](/docs/auto_arpa.md) for more information. -* Support for subnet targeting in dynamic records, see - [this section](/docs/dynamic_records.md#subnets) of dynamic records - documentation for more information. +* Beta support for auto-arpa has been added +* Support for subnet targeting in dynamic records * Enhanced validations on dynamic rules to encourage best practices * The last rule must be a catch-all w/o any targeted geos or subnets * Geos must not be repeated in multiple rules @@ -360,7 +356,7 @@ long (years) overdue. to do so, but weren't. There was an ordering before, but it was essentially arbitrarily picked. * Record.register_type added so that providers can register custom record - types, see [docs/records.md](docs/records.md) for more information + types. * New `octodns-versions` command which will log out the version of octodns and any provider/processor/plan_output modules you are using. @@ -503,9 +499,10 @@ long (years) overdue. * Alpha support for Processors has been added. Processors allow for hooking into the source, target, and planing process to make nearly arbitrary changes - to data. See the [octodns/processor/](/octodns/processor) directory for - examples. The change has been designed to have no impact on the process - unless the `processors` key is present in zone configs. + to data. See the + [octodns/processor/](https://github.com/octodns/octodns/tree/main/octodns/processor) + directory for examples. The change has been designed to have no impact on the + process unless the `processors` key is present in zone configs. * Fixes NS1 provider's geotarget limitation of using `NA` continent. Now, when `NA` is used in geos it considers **all** the countries of `North America` instead of just `us-east`, `us-west` and `us-central` regions diff --git a/docs/source/api.rst b/docs/api.rst similarity index 100% rename from docs/source/api.rst rename to docs/api.rst diff --git a/docs/source/api/processor.rst b/docs/api/processor.rst similarity index 100% rename from docs/source/api/processor.rst rename to docs/api/processor.rst diff --git a/docs/source/api/provider-yaml.rst b/docs/api/provider-yaml.rst similarity index 100% rename from docs/source/api/provider-yaml.rst rename to docs/api/provider-yaml.rst diff --git a/docs/source/api/provider.rst b/docs/api/provider.rst similarity index 100% rename from docs/source/api/provider.rst rename to docs/api/provider.rst diff --git a/docs/source/api/records.rst b/docs/api/records.rst similarity index 100% rename from docs/source/api/records.rst rename to docs/api/records.rst diff --git a/docs/source/api/source.rst b/docs/api/source.rst similarity index 100% rename from docs/source/api/source.rst rename to docs/api/source.rst diff --git a/docs/source/assets/deploy.png b/docs/assets/deploy.png similarity index 100% rename from docs/source/assets/deploy.png rename to docs/assets/deploy.png diff --git a/docs/source/assets/noop.png b/docs/assets/noop.png similarity index 100% rename from docs/source/assets/noop.png rename to docs/assets/noop.png diff --git a/docs/source/assets/octodns-logo.png b/docs/assets/octodns-logo.png similarity index 100% rename from docs/source/assets/octodns-logo.png rename to docs/assets/octodns-logo.png diff --git a/docs/source/assets/pr.png b/docs/assets/pr.png similarity index 100% rename from docs/source/assets/pr.png rename to docs/assets/pr.png diff --git a/docs/source/auto_arpa.md b/docs/auto_arpa.md similarity index 100% rename from docs/source/auto_arpa.md rename to docs/auto_arpa.md diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..2cc6760 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,5 @@ +# Changelog + +```{include} ../CHANGELOG.md + +``` diff --git a/docs/conf.py b/docs/conf.py index 4e21153..34b3f9f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -78,7 +78,7 @@ myst_heading_anchors = 3 ### content ### -master_doc = "source/index" +master_doc = "index" templates_path = ["_templates"] html_static_path = ["_static"] diff --git a/docs/source/configuration.rst b/docs/configuration.rst similarity index 100% rename from docs/source/configuration.rst rename to docs/configuration.rst diff --git a/docs/source/dynamic_records.rst b/docs/dynamic_records.rst similarity index 100% rename from docs/source/dynamic_records.rst rename to docs/dynamic_records.rst diff --git a/docs/source/examples/README.rst b/docs/examples/README.rst similarity index 100% rename from docs/source/examples/README.rst rename to docs/examples/README.rst diff --git a/docs/source/examples/basic/README.md b/docs/examples/basic/README.md similarity index 100% rename from docs/source/examples/basic/README.md rename to docs/examples/basic/README.md diff --git a/docs/source/examples/basic/config/my-domain.com.yaml b/docs/examples/basic/config/my-domain.com.yaml similarity index 100% rename from docs/source/examples/basic/config/my-domain.com.yaml rename to docs/examples/basic/config/my-domain.com.yaml diff --git a/docs/source/examples/basic/config/octodns.yaml b/docs/examples/basic/config/octodns.yaml similarity index 100% rename from docs/source/examples/basic/config/octodns.yaml rename to docs/examples/basic/config/octodns.yaml diff --git a/docs/source/examples/basic/config/unused-domain.io.yaml b/docs/examples/basic/config/unused-domain.io.yaml similarity index 100% rename from docs/source/examples/basic/config/unused-domain.io.yaml rename to docs/examples/basic/config/unused-domain.io.yaml diff --git a/docs/source/examples/basic/requirements.txt b/docs/examples/basic/requirements.txt similarity index 100% rename from docs/source/examples/basic/requirements.txt rename to docs/examples/basic/requirements.txt diff --git a/docs/source/examples/basic/target/my-domain.com.yaml b/docs/examples/basic/target/my-domain.com.yaml similarity index 100% rename from docs/source/examples/basic/target/my-domain.com.yaml rename to docs/examples/basic/target/my-domain.com.yaml diff --git a/docs/source/examples/basic/target/unused-domain.io.yaml b/docs/examples/basic/target/unused-domain.io.yaml similarity index 100% rename from docs/source/examples/basic/target/unused-domain.io.yaml rename to docs/examples/basic/target/unused-domain.io.yaml diff --git a/docs/source/examples/docker-compose.yml b/docs/examples/docker-compose.yml similarity index 100% rename from docs/source/examples/docker-compose.yml rename to docs/examples/docker-compose.yml diff --git a/docs/source/examples/env.sh b/docs/examples/env.sh similarity index 100% rename from docs/source/examples/env.sh rename to docs/examples/env.sh diff --git a/docs/source/examples/migrating-to-octodns/README.md b/docs/examples/migrating-to-octodns/README.md similarity index 100% rename from docs/source/examples/migrating-to-octodns/README.md rename to docs/examples/migrating-to-octodns/README.md diff --git a/docs/source/examples/migrating-to-octodns/config/octodns.yaml b/docs/examples/migrating-to-octodns/config/octodns.yaml similarity index 100% rename from docs/source/examples/migrating-to-octodns/config/octodns.yaml rename to docs/examples/migrating-to-octodns/config/octodns.yaml diff --git a/docs/source/examples/migrating-to-octodns/populate/my-dumpable.com.yaml b/docs/examples/migrating-to-octodns/populate/my-dumpable.com.yaml similarity index 100% rename from docs/source/examples/migrating-to-octodns/populate/my-dumpable.com.yaml rename to docs/examples/migrating-to-octodns/populate/my-dumpable.com.yaml diff --git a/docs/source/examples/migrating-to-octodns/populate/octodns.yaml b/docs/examples/migrating-to-octodns/populate/octodns.yaml similarity index 100% rename from docs/source/examples/migrating-to-octodns/populate/octodns.yaml rename to docs/examples/migrating-to-octodns/populate/octodns.yaml diff --git a/docs/source/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml b/docs/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml similarity index 100% rename from docs/source/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml rename to docs/examples/migrating-to-octodns/populate/unused-dumpable.com.yaml diff --git a/docs/source/examples/migrating-to-octodns/requirements.txt b/docs/examples/migrating-to-octodns/requirements.txt similarity index 100% rename from docs/source/examples/migrating-to-octodns/requirements.txt rename to docs/examples/migrating-to-octodns/requirements.txt diff --git a/docs/source/getting-started.rst b/docs/getting-started.rst similarity index 100% rename from docs/source/getting-started.rst rename to docs/getting-started.rst diff --git a/docs/source/index.rst b/docs/index.rst similarity index 99% rename from docs/source/index.rst rename to docs/index.rst index 51f0bbf..0292e70 100644 --- a/docs/source/index.rst +++ b/docs/index.rst @@ -32,6 +32,7 @@ Documentation auto_arpa.rst examples/README.rst api.rst + changelog.md .. _provider-list: diff --git a/docs/info/changelog.md b/docs/info/changelog.md deleted file mode 100644 index d108f58..0000000 --- a/docs/info/changelog.md +++ /dev/null @@ -1,5 +0,0 @@ -# Changelog - -```{include} ../../CHANGELOG.md - -``` diff --git a/docs/info/license.md b/docs/info/license.md deleted file mode 100644 index eef79d3..0000000 --- a/docs/info/license.md +++ /dev/null @@ -1,5 +0,0 @@ -# License - -```{include} ../../LICENSE - -``` diff --git a/docs/source/records.rst b/docs/records.rst similarity index 100% rename from docs/source/records.rst rename to docs/records.rst diff --git a/script/generate-docs b/script/generate-docs index becca7e..8d73b76 100755 --- a/script/generate-docs +++ b/script/generate-docs @@ -22,6 +22,6 @@ if [ -z "$BUILDER" ]; then fi build="_build/${BUILDER}" -rm -rf "$build" source/api/records/ source/api/processors/ +rm -rf "$build" api/records/ api/processors/ -sphinx-build --builder "$BUILDER" --conf-dir . --fail-on-warning "$@" "source/" "$build" +sphinx-build --builder "$BUILDER" --conf-dir . --fail-on-warning "$@" "." "$build"