File: sidebar_dropdown_apiref-993b4dba4c0369f6.yaml

package info (click to toggle)
python-openstackdocstheme 3.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,008 kB
  • sloc: javascript: 8,326; python: 544; makefile: 162; sh: 152
file content (29 lines) | stat: -rw-r--r-- 746 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
---
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.