diff options
author | Javier Jardón <jjardon@gnome.org> | 2018-03-19 00:49:53 +0000 |
---|---|---|
committer | Javier Jardón <jjardon@gnome.org> | 2018-03-20 15:35:07 +0000 |
commit | 54827aa77d095aac1b2bc205cc124c0e6185b5a0 (patch) | |
tree | af001135692490cc1b25b0e359402f04ef8f4e18 | |
parent | e8e88e5c746e391da49b3eecba13414a11e55084 (diff) | |
download | buildstream-54827aa77d095aac1b2bc205cc124c0e6185b5a0.tar.gz |
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
-rw-r--r-- | .gitlab-ci.yml | 1 | ||||
-rw-r--r-- | HACKING.rst | 1 | ||||
-rw-r--r-- | doc/source/conf.py | 7 | ||||
-rw-r--r-- | doc/source/index.rst | 37 |
4 files changed, 21 insertions, 25 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5be48c181..99d54e143 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -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 diff --git a/HACKING.rst b/HACKING.rst index 5763c1051..e89e28211 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -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. diff --git a/doc/source/conf.py b/doc/source/conf.py index 418a99f5d..ab9a554eb 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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. # diff --git a/doc/source/index.rst b/doc/source/index.rst index 36aa749bc..ca594aabf 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 |