Skip to content
Snippets Groups Projects
Commit 27860f4d authored by Antoine Pietri's avatar Antoine Pietri
Browse files

Switch to sphinx_rtd_theme

Addresses T1983
parent 295a8e37
No related branches found
No related tags found
No related merge requests found
*-stamp
_build/
/swh-*
!/swh-loader.rst
sources/
docs/_static/software-heritage-logo-title-motto-vertical-white.png

16.5 KiB

This diff is collapsed.
......@@ -3,10 +3,6 @@
Software Heritage - Development Documentation
=============================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Getting started
---------------
......@@ -135,12 +131,27 @@ Indices and tables
.. ensure sphinx does not complain about index files not being included
.. toctree::
:maxdepth: 2
:caption: Contents:
:titlesonly:
:hidden:
:glob:
architecture
getting-started
developer-setup
manual-setup
apidoc/modules
swh-*/index
API documentation <apidoc/modules>
swh.core <swh-core/index>
swh.dataset <swh-dataset/index>
swh.deposit <swh-deposit/index>
swh.graph <swh-graph/index>
swh.indexer <swh-indexer/index>
swh.journal <swh-journal/index>
swh.lister <swh-lister/index>
swh.loader <swh-loader>
swh.model <swh-model/index>
swh.objstorage <swh-objstorage/index>
swh.scheduler <swh-scheduler/index>
swh.storage <swh-storage/index>
swh.vault <swh-vault/index>
swh.web <swh-web/index>
Loaders
=======
.. toctree::
:maxdepth: 2
:caption: Contents:
:titlesonly:
swh.loader.core <swh-loader-core/index>
swh.loader.debian <swh-loader-debian/index>
swh.loader.dir <swh-loader-dir/index>
swh.loader.git <swh-loader-git/index>
swh.loader.mercurial <swh-loader-mercurial/index>
swh.loader.pypi <swh-loader-pypi/index>
swh.loader.svn <swh-loader-svn/index>
swh.loader.tar <swh-loader-tar/index>
......@@ -8,3 +8,4 @@ sphinxcontrib-images
sphinxcontrib-programoutput
sphinx-tabs
recommonmark
sphinx_rtd_theme
......@@ -23,6 +23,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinxcontrib.programoutput',
'sphinx.ext.viewcode',
'sphinx_tabs.tabs',
'sphinx_rtd_theme',
]
# Add any paths that contain templates here, relative to this directory.
......@@ -81,7 +82,7 @@ todo_include_todos = True
# 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'
html_favicon = '_static/favicon.ico'
......@@ -90,18 +91,12 @@ html_favicon = '_static/favicon.ico'
# documentation.
#
html_theme_options = {
'logo': 'software-heritage-logo-title-motto-vertical.svg',
'font_family': "'Alegreya Sans', sans-serif",
'head_font_family': "'Alegreya', serif",
# equivalent of alabaster's:
'gray_1': '#5b5e6f', # dark gray
'gray_2': '#efeff2', # light gray
'gray_3': '#b1b5ae', # medium gray
'pink_1': '#e5d4cf', # light pink
'pink_2': '#bd9f97', # medium pink
'fixed_sidebar': 'true',
'collapse_navigation': True,
'sticky_navigation': True,
}
html_logo = 'software-heritage-logo-title-motto-vertical-white.png'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
......@@ -112,7 +107,7 @@ html_static_path = ['_static']
html_sidebars = {
'**': [
'about.html',
'localtoc.html',
'globaltoc.html',
'relations.html',
'sourcelink.html',
'searchbox.html',
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment