diff options
| author |   Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-03-28 10:27:51 -0700 |
|---|---|---|
| committer | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-04-20 11:05:50 -0700 |
| commit | bd331b2451a17eaf5ed8f6fc8aa89f0499031c28 (patch) | |
| tree | 3bcf69b472c8b4af97ce8842e49ec12049b750b2 /opnfv-theme/README.rst | |
| parent | b66a62102b39654b389f5cd186d7468f43b97522 (diff) | |
Update OPNFV Sphinx Theme
When the theme was initially created I was under the assumption the
directory the theme lives under needs to match the name. This does not
seem to be the case and in fact seems to cause issues with correctly
importing and using the theme.
Includes formatting updates to the README and linting.
Change-Id: I67c834bfe9dc99252159394ecbf136d9a264e0a8
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Diffstat (limited to 'opnfv-theme/README.rst')
| -rw-r--r-- | opnfv-theme/README.rst | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/opnfv-theme/README.rst b/opnfv-theme/README.rst index 484a7a793..c307768fb 100644 --- a/opnfv-theme/README.rst +++ b/opnfv-theme/README.rst @@ -12,21 +12,23 @@ Here's how to install the theme from PyPI_ To install and configure the theme do the following. -#. Install the theme from pypi:: +#. Install the theme from pypi: - $ pip install sphinx_opnfv_theme + .. code-block:: bash + + $ pip install sphinx_opnfv_theme #. Configure Sphinx to use the theme: -.. code-block:: python + .. code-block:: python - # conf.py - import sphinx_opnfv_theme + # conf.py + import sphinx_opnfv_theme - # ... + # ... - html_theme = 'opnfv' - html_theme_path = sphinx_opnfv_theme.get_html_theme_path() + html_theme = 'opnfv' + html_theme_path = sphinx_opnfv_theme.get_html_theme_path() Customization ------------- @@ -39,7 +41,7 @@ following options for the bootstrap theme:: html_theme_options = { 'bootswatch_theme': 'journal', - 'navbar_sidebarrel': false, + 'navbar_sidebarrel': False, 'navbar_title': '', } |