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    $ pip install sphinx_opnfv_theme
  18
  19 #. Configure Sphinx to use the theme:
  20
  21 .. code-block:: python
  22
  23    # conf.py
  24    import sphinx_opnfv_theme
  25
  26    # ...
  27
  28    html_theme = 'opnfv'
  29    html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
  30
  31 Customization
  32 -------------
  33
  34 There are no customization specific to this theme yet, but all
  35 all customizations_ Sphinx Bootstrap Theme are supported.
  36
  37 If you'd like your documentation to match OPNFV's style configure the
  38 following options for the bootstrap theme::
  39
  40   html_theme_options = {
  41     'bootswatch_theme': 'journal',
  42     'navbar_sidebarrel': false,
  43     'navbar_title': '',
  44   }
  45
  46 .. _Sphinx Bootstrap Theme: https://github.com/ryan-roemer/sphinx-bootstrap-theme
  47 .. _Pypi: http://pypi.python.org/pypi/sphinx-opnfv-theme/
  48 .. _customizations: https://github.com/ryan-roemer/sphinx-bootstrap-theme#customization