From 7c0ebd310ce592905cb60a94cc8d3067f7d0f677 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Mon, 15 Oct 2018 12:16:05 -0400 Subject: [PATCH] Add top-level CLI reference page in docs This creates the top-level cli/ reference in the docs and moves the designate-manage docs to that CLI reference. A redirect is added for sending old links to the new home for the designate-manage.html page. We'll build on this to add docs for the new designate-status upgrade check command. Change-Id: Ic05bc343131651edc7379976fdc877cfb286e310 --- doc/source/_extra/.htaccess | 1 + doc/source/admin/index.rst | 1 - doc/source/{admin => cli}/designate-manage.rst | 2 +- doc/source/cli/index.rst | 10 ++++++++++ doc/source/conf.py | 3 +++ doc/source/index.rst | 1 + 6 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 doc/source/_extra/.htaccess rename doc/source/{admin => cli}/designate-manage.rst (99%) create mode 100644 doc/source/cli/index.rst diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess new file mode 100644 index 000000000..9d5405854 --- /dev/null +++ b/doc/source/_extra/.htaccess @@ -0,0 +1 @@ +redirectmatch 301 ^/designate/([^/]+)/admin/designate-manage.html$ /designate/$1/cli/designate-manage.html diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 5351582e8..02a22406e 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -18,7 +18,6 @@ Contents: multiple-pools blacklists quotas - designate-manage policy config notifications diff --git a/doc/source/admin/designate-manage.rst b/doc/source/cli/designate-manage.rst similarity index 99% rename from doc/source/admin/designate-manage.rst rename to doc/source/cli/designate-manage.rst index 63ed3bc0c..4f8220de9 100644 --- a/doc/source/admin/designate-manage.rst +++ b/doc/source/cli/designate-manage.rst @@ -1,4 +1,4 @@ - .. _designate-manage: +.. _designate-manage: ==================== Designate Manage CLI diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 000000000..81369cccc --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,10 @@ +Command-Line Interface Reference +================================ + +Information on the commands available through Designate's Command Line +Interface (CLI) can be found in this section. + +.. toctree:: + :maxdepth: 1 + + designate-manage diff --git a/doc/source/conf.py b/doc/source/conf.py index f2cb2713b..be6bcdc1e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -149,6 +149,9 @@ html_theme_options = {} # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +# Add any paths that contain "extra" files, such as .htaccess. +html_extra_path = ['_extra'] + # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' diff --git a/doc/source/index.rst b/doc/source/index.rst index efe12225a..997d884e2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,6 +18,7 @@ Contents user/index admin/index configuration/index + cli/index For information on the Designate API, see the `API Reference `_.