summaryrefslogtreecommitdiffstats
path: root/opnfv-theme/README.rst
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2018-04-23 15:18:56 +0000
committerGerrit Code Review <gerrit@opnfv.org>2018-04-23 15:18:56 +0000
commit98fa6c92ed1326896671e23dac2f470c96e471ca (patch)
tree4ed3a273d8ddc66d50fb4c39fa8fd7fdce7e957a /opnfv-theme/README.rst
parentf39141858f45df25e7cb77a51442135cae33c52e (diff)
parentbd331b2451a17eaf5ed8f6fc8aa89f0499031c28 (diff)
Merge "Update OPNFV Sphinx Theme"
Diffstat (limited to 'opnfv-theme/README.rst')
-rw-r--r--opnfv-theme/README.rst20
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': '',
}