openstack/designate
Code Issues Proposed changes

Update docs formatting

Browse Source 
Allow the sidebar TOC to actually contain the sections that we have
here.

Change-Id: Ieb9eb0a9a532397c36812bdffe6f2962aca7448a
Related-Bug: 1713081
This commit is contained in:
Jens Harbott 2017-09-05 10:03:11 +00:00
parent 2a6d38dbf5
commit 7874aa1eb3
2 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/conf.py
View File

@ -114,10 +114,7 @@ html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
# documentation. # documentation.
html_theme_options = { html_theme_options = {}
"sidebar_mode": "toc",
"display_toc": True
}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [] #html_theme_path = []

9
doc/source/index.rst
View File

@ -7,12 +7,6 @@ API with integrated Keystone authentication. It can be configured to
auto-generate records based on Nova and Neutron actions. Designate supports auto-generate records based on Nova and Neutron actions. Designate supports
a variety of DNS servers including Bind9 and PowerDNS. a variety of DNS servers including Bind9 and PowerDNS.
For information on how to install Designate, see the
`Install Guide <https://docs.openstack.org/dns/latest/install/>`_.
For information on the Designate API, see the
`API Reference <https://developer.openstack.org/api-ref/dns/>`_.
Contents Contents
~~~~~~~~ ~~~~~~~~
@ -25,5 +19,8 @@ Contents
admin/index admin/index
configuration/index configuration/index
For information on the Designate API, see the
`API Reference <https://developer.openstack.org/api-ref/dns/>`_.
This documentation is generated by the Sphinx toolkit and lives in the This documentation is generated by the Sphinx toolkit and lives in the
`source tree <https://git.openstack.org/cgit/openstack/designate>`_. `source tree <https://git.openstack.org/cgit/openstack/designate>`_.