diff --git a/docs/.gitignore b/docs/.gitignore
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1,4 +1,5 @@
*-stamp
_build/
/swh-*
+!/swh-loader.rst
sources/
diff --git a/docs/_static/software-heritage-logo-title-motto-vertical-white.svg b/docs/_static/software-heritage-logo-title-motto-vertical-white.svg
new file mode 100644
--- /dev/null
+++ b/docs/_static/software-heritage-logo-title-motto-vertical-white.svg
@@ -0,0 +1,234 @@
+
+
+
+
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,10 +3,6 @@
Software Heritage - Development Documentation
=============================================
-.. toctree::
- :maxdepth: 2
- :caption: Contents:
-
Getting started
---------------
@@ -135,12 +131,27 @@
.. 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
+ swh.core
+ swh.dataset
+ swh.deposit
+ swh.graph
+ swh.indexer
+ swh.journal
+ swh.lister
+ swh.loader
+ swh.model
+ swh.objstorage
+ swh.scheduler
+ swh.storage
+ swh.vault
+ swh.web
diff --git a/docs/swh-loader.rst b/docs/swh-loader.rst
new file mode 100644
--- /dev/null
+++ b/docs/swh-loader.rst
@@ -0,0 +1,16 @@
+Loaders
+=======
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+ :titlesonly:
+
+ swh.loader-core
+ swh.loader-debian
+ swh.loader-dir
+ swh.loader-git
+ swh.loader-mercurial
+ swh.loader-pypi
+ swh.loader-svn
+ swh.loader-tar
diff --git a/requirements.txt b/requirements.txt
--- a/requirements.txt
+++ b/requirements.txt
@@ -8,3 +8,4 @@
sphinxcontrib-programoutput
sphinx-tabs
recommonmark
+sphinx_rtd_theme
diff --git a/swh/docs/sphinx/conf.py b/swh/docs/sphinx/conf.py
--- a/swh/docs/sphinx/conf.py
+++ b/swh/docs/sphinx/conf.py
@@ -23,6 +23,7 @@
'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 @@
# 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 @@
# 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.svg'
+
# 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_sidebars = {
'**': [
'about.html',
- 'localtoc.html',
+ 'globaltoc.html',
'relations.html',
'sourcelink.html',
'searchbox.html',