diff --git a/docs/conf.py b/docs/conf.py index 89db221..190deb7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1 @@ from swh.docs.sphinx.conf import * # NoQA - -# For swh-web, needed to allow import of django modules (sigh). Note: this is -# here and not in swh.docs.sphinx.docs to avoid forcing a django dependency on -# every module that uses the common Sphinx configuration. -import os -import django -os.environ.setdefault("DJANGO_SETTINGS_MODULE", "swh.web.settings.development") -django.setup() diff --git a/swh/docs/sphinx/conf.py b/swh/docs/sphinx/conf.py index bc2db3b..33db531 100644 --- a/swh/docs/sphinx/conf.py +++ b/swh/docs/sphinx/conf.py @@ -1,83 +1,86 @@ #!/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' # 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']