Commit 54827aa7 authored by Javier Jardón's avatar Javier Jardón

Change theme to sphinx_rtd_theme

The sphinx_rtd_theme is a sphinx theme designed to look modern and be mobile-friendly
http://sphinx-rtd-theme.readthedocs.io/en/latest/index.html
parent e8e88e5c
......@@ -136,6 +136,7 @@ docs:
- dnf install -y python2
- pip3 install sphinx
- pip3 install sphinx-click
- pip3 install sphinx_rtd_theme
- cd dist && ./unpack.sh && cd buildstream
- pip3 install .
- make -C doc
......
......@@ -132,6 +132,7 @@ other mechanism::
pip install --user sphinx
pip install --user sphinx-click
pip install --user sphinx_rtd_theme
Furthermore, the documentation build requires that BuildStream itself
be installed.
......
......@@ -124,7 +124,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
......@@ -181,11 +181,6 @@ html_static_path = []
#
# html_sidebars = {}
# Remove the obnoxious "This Page" and view page source shortcut
html_sidebars = {
'**': ['localtoc.html', 'relations.html', 'searchbox.html']
}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
......
......@@ -3,11 +3,6 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. toctree::
:maxdepth: 2
:hidden:
modules
BuildStream Documentation
=========================
......@@ -22,22 +17,26 @@ on *filesystem data* as input and output, and are related to eachother by their
dependencies.
Installing
----------
* :ref:`installing`
* :ref:`docker`
* :ref:`artifacts`
.. toctree::
:maxdepth: 2
:caption: Installing
install
docker
artifacts
Documentation
-------------
* :ref:`main_using`
* :ref:`main_authoring`
* :ref:`main_core`
.. toctree::
:maxdepth: 2
:caption: Reference documentation
main_using
main_authoring
main_core
Indices and tables
------------------
* :ref:`modindex`
* :ref:`genindex`
.. toctree::
:maxdepth: 2
:hidden:
modules
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment