diff --git a/requirements.txt b/requirements.txt index 395e12a..7960041 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,6 @@ # 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 +recommonmark diff --git a/swh/docs/sphinx/conf.py b/swh/docs/sphinx/conf.py index 1c7cbee..02b9903 100644 --- a/swh/docs/sphinx/conf.py +++ b/swh/docs/sphinx/conf.py @@ -1,119 +1,123 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # General information about the project. project = 'Software Heritage - Development Documentation' copyright = '2015-2017, 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', 'sphinx.ext.intersphinx'] # 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_suffix = ['.rst', '.md'] +# source_suffix = '.rst' + +source_parsers = { + '.md': 'recommonmark.parser.CommonMarkParser', +} # The master toctree document. master_doc = 'index' # 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' # 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 = {} # 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'] # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/3/': None} # -- autodoc configuration ---------------------------------------------- autodoc_default_flags = ['members', 'undoc-members'] # Do not import django as it needs to load its configuration file (ref: T763) autodoc_mock_imports = [ 'django', 'django.apps', 'django.conf.urls', 'django.contrib.staticfiles.urls', 'django.core', 'django.core.cache', 'django.core.exceptions', 'django.core.paginator', 'django.core.wsgi', 'django.db', 'django.db.models', 'django.db.models.fields', 'django.http', 'django.http.multipartparser', 'django.http.response', 'django.shortcuts', 'django.template', 'django.template.response', 'django.test', 'django.test.client', 'django.test.signals', 'django.utils.encoding', 'django.utils.functional', 'django.utils.safestring', 'django.utils.six', 'django.utils.six.moves', 'django.utils.six.moves.http_client', 'django.utils.translation', 'django.views', 'django.views.decorators', 'django.views.decorators.csrf', 'django.views.generic', ]