diff --git a/docs/.gitignore b/docs/.gitignore
index e76b2db..1fb132d 100644
--- 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.png b/docs/_static/software-heritage-logo-title-motto-vertical-white.png
new file mode 100644
index 0000000..c7559bf
Binary files /dev/null and b/docs/_static/software-heritage-logo-title-motto-vertical-white.png differ
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
index 0000000..a2ee65f
--- /dev/null
+++ b/docs/_static/software-heritage-logo-title-motto-vertical-white.svg
@@ -0,0 +1,236 @@
+
+
+
+
diff --git a/docs/index.rst b/docs/index.rst
index 0419ad1..ff58f2e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,146 +1,157 @@
.. _swh-docs:
Software Heritage - Development Documentation
=============================================
-.. toctree::
- :maxdepth: 2
- :caption: Contents:
-
Getting started
---------------
* :ref:`getting-started` ← start here to get your own Software Heritage
platform running in less than 5 minutes, or
* :ref:`developer-setup` ← here to hack on the Software Heritage software
stack
Architecture
------------
* :ref:`architecture` ← go there to have a glimpse on the Software Heritage software
architecture
Components
----------
Here is brief overview of the most relevant software components in the Software
Heritage stack. Each component name is linked to the development documentation
of the corresponding Python module.
:ref:`swh.core `
low-level utilities and helpers used by almost all other modules in the
stack
:ref:`swh.dataset `
public datasets and periodic data dumps of the archive released by Software
Heritage
:ref:`swh.deposit `
push-based deposit of software artifacts to the archive
swh.docs
developer documentation (used to generate this doc you are reading)
:ref:`swh.graph `
Fast, compressed, in-memory representation of the archive, with tooling to
generate and query it.
:ref:`swh.indexer `
tools and workers used to crawl the content of the archive and extract
derived information from any artifact stored in it
:ref:`swh.journal `
persistent logger of changes to the archive, with publish-subscribe support
:ref:`swh.lister `
collection of listers for all sorts of source code hosting and distribution
places (forges, distributions, package managers, etc.)
:ref:`swh.loader-core `
low-level loading utilities and helpers used by all other loaders
:ref:`swh.loader-debian `
loader for `Debian `_ source packages
:ref:`swh.loader-dir `
loader for source directories (e.g., expanded tarballs)
:ref:`swh.loader-git `
loader for `Git `_ repositories
:ref:`swh.loader-mercurial `
loader for `Mercurial `_ repositories
:ref:`swh.loader-pypi `
loader for `PyPI `_ source code releases
:ref:`swh.loader-svn `
loader for `Subversion `_ repositories
:ref:`swh.loader-tar `
loader for source tarballs (including Tar, ZIP and other archive formats)
:ref:`swh.model `
implementation of the :ref:`data-model` to archive source code artifacts
:ref:`swh.objstorage `
content-addressable object storage
:ref:`swh.scheduler `
task manager for asynchronous/delayed tasks, used for recurrent (e.g.,
listing a forge, loading new stuff from a Git repository) and one-off
activities (e.g., loading a specific version of a source package)
:ref:`swh.storage `
abstraction layer over the archive, allowing to access all stored source
code artifacts as well as their metadata
:ref:`swh.vault `
implementation of the vault service, allowing to retrieve parts of the
archive as self-contained bundles (e.g., individual releases, entire
repository snapshots, etc.)
:ref:`swh.web `
Web application(s) to browse the archive, for both interactive (HTML UI)
and mechanized (REST API) use
Dependencies
------------
The dependency relationships among the various modules are depicted below.
.. _py-deps-swh:
.. figure:: images/py-deps-swh.svg
:width: 1024px
:align: center
Dependencies among top-level Python modules (click to zoom).
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* `URLs index `_
* :ref:`search`
* :ref:`glossary`
.. 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
index 0000000..0733fd0
--- /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
index 90fe243..dcf3149 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,10 +1,11 @@
# Add here external Python modules dependencies, one per line. Module names
# should match https://pypi.python.org/pypi names. For the full spec or
# dependency lines, see https://pip.readthedocs.org/en/1.1/requirements.html
vcversioner
sphinx >= 1.3, < 2
sphinxcontrib-httpdomain
sphinxcontrib-images
sphinxcontrib-programoutput
sphinx-tabs
recommonmark
+sphinx_rtd_theme
diff --git a/swh/docs/sphinx/conf.py b/swh/docs/sphinx/conf.py
index b7d5eae..d28abd5 100755
--- a/swh/docs/sphinx/conf.py
+++ b/swh/docs/sphinx/conf.py
@@ -1,160 +1,155 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
import django
import os
# General information about the project.
project = 'Software Heritage - Development Documentation'
copyright = '2015-2018, the Software Heritage developers'
author = 'the Software Heritage developers'
# -- General configuration ------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinxcontrib.httpdomain',
'sphinx.ext.extlinks',
'sphinxcontrib.images',
'sphinxcontrib.programoutput',
'sphinx.ext.viewcode',
'sphinx_tabs.tabs',
+ 'sphinx_rtd_theme',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = ['.rst', '.md']
# source_suffix = '.rst'
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
# The master toctree document.
master_doc = 'index'
# A string of reStructuredText that will be included at the beginning of every
# source file that is read.
# A bit hackish but should work both for each swh package and the whole swh-doc
rst_prolog = '''
.. include:: /../../swh-docs/docs/swh_substitutions
'''
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = ''
# The full version, including alpha/beta/rc tags.
release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# -- Options for HTML output ----------------------------------------------
# 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'
# 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
# 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".
html_static_path = ['_static']
# make logo actually appear, avoiding gotcha due to alabaster default conf.
# https://github.com/bitprophet/alabaster/issues/97#issuecomment-303722935
html_sidebars = {
'**': [
'about.html',
- 'localtoc.html',
+ 'globaltoc.html',
'relations.html',
'sourcelink.html',
'searchbox.html',
]
}
# refer to the Python standard library.
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
# -- autodoc configuration ----------------------------------------------
autodoc_default_flags = ['members', 'undoc-members', 'private-members',
'special-members']
autodoc_member_order = 'bysource'
autodoc_mock_imports = ['rados']
modindex_common_prefix = ['swh.']
# for the extlinks extension, sub-projects should fill that dict
extlinks = {}
# XXX Kill this ASA this PR is accepted and released
# https://github.com/sphinx-contrib/httpdomain/pull/19
def register_routingtable_as_label(app, document):
from sphinx.locale import _ # noqa
labels = app.env.domaindata['std']['labels']
labels['routingtable'] = 'http-routingtable', '', _('HTTP Routing Table')
anonlabels = app.env.domaindata['std']['anonlabels']
anonlabels['routingtable'] = 'http-routingtable', ''
# hack to set the adequate django settings when building global swh doc
# to avoid autodoc build errors
def setup(app):
os.environ.setdefault('DJANGO_SETTINGS_MODULE',
'swh.docs.django_settings')
django.setup()
import pkg_resources # noqa
from distutils.version import StrictVersion # noqa
httpdomain = pkg_resources.get_distribution('sphinxcontrib-httpdomain')
if StrictVersion(httpdomain.version) <= StrictVersion('1.7.0'):
app.connect('doctree-read', register_routingtable_as_label)