47149987c1
- Adds a theme variable, sidebar_dropdown, to set a dropdown menu for the API references. To test, uncomment the parameter html_theme_options in doc/source/conf.py OR build the API Ref demo docs. - Adds an API Ref docs demo integrating os-api-ref and openstackdocstheme. Tested with webserver: python -m SimpleHTTPServer <port_num>. Change-Id: I346695cd407ecf4efc0a5e00f2c0ccc1ea099ec5
30 lines
746 B
YAML
30 lines
746 B
YAML
---
|
|
prelude: >
|
|
Adds a theme variable, ``sidebar_dropdown`` to configure
|
|
the display of the new API sidebar dropdown menu.
|
|
features:
|
|
- |
|
|
Adds the option to configure the display of a sidebar dropdown
|
|
menu for published API References and Guides.
|
|
In conf.py, set the theme variable, ``html_theme_options`` to
|
|
include the parameter, ``sidebar_dropdown`` as ``api_ref``. For
|
|
example:
|
|
|
|
::
|
|
|
|
html_theme_options = {
|
|
"sidebar_dropdown": "api_ref",
|
|
}
|
|
|
|
The extensions parameter should include the sphinx extension,
|
|
``os_api_ref``.
|
|
|
|
::
|
|
|
|
extensions = [
|
|
'os_api_ref',
|
|
]
|
|
|
|
- Publishes an API Reference demo which is integrated with the
|
|
API sidebar dropdown menu.
|