Update git submodules
[opnfvdocs.git] / opnfv-theme / README.rst
1 OPNFV Documentation Theme
2 =========================
3
4 This theme is used for all OPNFV documentation and is released seperatly
5 from the documentation itself. It's and extention of the `Sphinx
6 Bootstrap Theme`_
7
8 Installation
9 ------------
10
11 Here's how to install the theme from PyPI_
12
13 To install and configure the theme do the following.
14
15 #. Install the theme from pypi:
16
17    .. code-block:: bash
18
19       $ pip install sphinx_opnfv_theme
20
21 #. Configure Sphinx to use the theme:
22
23    .. code-block:: python
24
25       # conf.py
26       import sphinx_opnfv_theme
27
28       # ...
29
30       html_theme = 'opnfv'
31       html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
32
33 Customization
34 -------------
35
36 There are no customization specific to this theme yet, but all
37 all customizations_ Sphinx Bootstrap Theme are supported.
38
39 If you'd like your documentation to match OPNFV's style configure the
40 following options for the bootstrap theme::
41
42   html_theme_options = {
43     'bootswatch_theme': 'journal',
44     'navbar_sidebarrel': False,
45     'navbar_title': '',
46   }
47
48 .. _Sphinx Bootstrap Theme: https://github.com/ryan-roemer/sphinx-bootstrap-theme
49 .. _Pypi: http://pypi.python.org/pypi/sphinx-opnfv-theme/
50 .. _customizations: https://github.com/ryan-roemer/sphinx-bootstrap-theme#customization