Code Review
/
opnfvdocs.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Update docs/testing/testing-dev.rst, docs/testing/testing-user.rst files
[opnfvdocs.git]
/
opnfv-theme
/
README.rst
diff --git
a/opnfv-theme/README.rst
b/opnfv-theme/README.rst
index
484a7a7
..
c307768
100644
(file)
--- 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.
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:
#. 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
-------------
Customization
-------------
@@
-39,7
+41,7
@@
following options for the bootstrap theme::
html_theme_options = {
'bootswatch_theme': 'journal',
html_theme_options = {
'bootswatch_theme': 'journal',
- 'navbar_sidebarrel':
f
alse,
+ 'navbar_sidebarrel':
F
alse,
'navbar_title': '',
}
'navbar_title': '',
}