Commit 30c47a28 authored by Sébastiaan Versteeg's avatar Sébastiaan Versteeg
Browse files

Merge branch 'renovate/sphinx-2.x' into 'master'

Update dependency sphinx to ~2.1

See merge request !1280
parents 676825d4 7d518519
...@@ -2,9 +2,9 @@ activemembers.api package ...@@ -2,9 +2,9 @@ activemembers.api package
========================= =========================
.. automodule:: activemembers.api .. automodule:: activemembers.api
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Submodules Submodules
---------- ----------
...@@ -13,32 +13,31 @@ activemembers.api.permissions module ...@@ -13,32 +13,31 @@ activemembers.api.permissions module
------------------------------------ ------------------------------------
.. automodule:: activemembers.api.permissions .. automodule:: activemembers.api.permissions
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.api.serializers module activemembers.api.serializers module
------------------------------------ ------------------------------------
.. automodule:: activemembers.api.serializers .. automodule:: activemembers.api.serializers
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.api.urls module activemembers.api.urls module
----------------------------- -----------------------------
.. automodule:: activemembers.api.urls .. automodule:: activemembers.api.urls
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.api.views module activemembers.api.views module
------------------------------ ------------------------------
.. automodule:: activemembers.api.views .. automodule:: activemembers.api.views
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
...@@ -2,16 +2,16 @@ activemembers package ...@@ -2,16 +2,16 @@ activemembers package
===================== =====================
.. automodule:: activemembers .. automodule:: activemembers
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Subpackages Subpackages
----------- -----------
.. toctree:: .. toctree::
activemembers.api activemembers.api
Submodules Submodules
---------- ----------
...@@ -20,64 +20,63 @@ activemembers.admin module ...@@ -20,64 +20,63 @@ activemembers.admin module
-------------------------- --------------------------
.. automodule:: activemembers.admin .. automodule:: activemembers.admin
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.apps module activemembers.apps module
------------------------- -------------------------
.. automodule:: activemembers.apps .. automodule:: activemembers.apps
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.backends module activemembers.backends module
----------------------------- -----------------------------
.. automodule:: activemembers.backends .. automodule:: activemembers.backends
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.forms module activemembers.forms module
-------------------------- --------------------------
.. automodule:: activemembers.forms .. automodule:: activemembers.forms
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.models module activemembers.models module
--------------------------- ---------------------------
.. automodule:: activemembers.models .. automodule:: activemembers.models
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.sitemaps module activemembers.sitemaps module
----------------------------- -----------------------------
.. automodule:: activemembers.sitemaps .. automodule:: activemembers.sitemaps
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.urls module activemembers.urls module
------------------------- -------------------------
.. automodule:: activemembers.urls .. automodule:: activemembers.urls
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
activemembers.views module activemembers.views module
-------------------------- --------------------------
.. automodule:: activemembers.views .. automodule:: activemembers.views
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
...@@ -2,9 +2,9 @@ announcements package ...@@ -2,9 +2,9 @@ announcements package
===================== =====================
.. automodule:: announcements .. automodule:: announcements
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Submodules Submodules
---------- ----------
...@@ -13,48 +13,47 @@ announcements.admin module ...@@ -13,48 +13,47 @@ announcements.admin module
-------------------------- --------------------------
.. automodule:: announcements.admin .. automodule:: announcements.admin
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
announcements.apps module announcements.apps module
------------------------- -------------------------
.. automodule:: announcements.apps .. automodule:: announcements.apps
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
announcements.context\_processors module announcements.context\_processors module
---------------------------------------- ----------------------------------------
.. automodule:: announcements.context_processors .. automodule:: announcements.context_processors
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
announcements.models module announcements.models module
--------------------------- ---------------------------
.. automodule:: announcements.models .. automodule:: announcements.models
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
announcements.urls module announcements.urls module
------------------------- -------------------------
.. automodule:: announcements.urls .. automodule:: announcements.urls
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
announcements.views module announcements.views module
-------------------------- --------------------------
.. automodule:: announcements.views .. automodule:: announcements.views
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
...@@ -24,7 +24,6 @@ sys.path.insert(0, os.path.abspath('../website')) ...@@ -24,7 +24,6 @@ sys.path.insert(0, os.path.abspath('../website'))
import django import django
from django.conf import settings # noqa from django.conf import settings # noqa
from recommonmark.parser import CommonMarkParser # noqa
from thaliawebsite import settings as thalia_settings # noqa from thaliawebsite import settings as thalia_settings # noqa
...@@ -50,24 +49,18 @@ extensions = [ ...@@ -50,24 +49,18 @@ extensions = [
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
'sphinx.ext.graphviz', 'sphinx.ext.graphviz',
'recommonmark',
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = 'Concrexit' project = 'Concrexit'
copyright = "2017, Technicie, Studievereniging Thalia" copyright = "2017--2019, Technicie, Studievereniging Thalia"
author = "Technicie, Studievereniging Thalia" author = "Technicie, Studievereniging Thalia"
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
...@@ -178,8 +171,11 @@ texinfo_documents = [ ...@@ -178,8 +171,11 @@ texinfo_documents = [
# -- Options for autodoc -------------------------------------------------- # -- Options for autodoc --------------------------------------------------
# Default flags for autodoc, saves typing # Default options for autodoc
autodoc_default_flags = ['members', 'undoc-members'] autodoc_default_options = {
'members': True,
'undoc-members': True,
}
# We need to mock the modules for the sphinx build in the docker. # We need to mock the modules for the sphinx build in the docker.
autodoc_mock_imports = ['factory', 'pydenticon', 'faker'] autodoc_mock_imports = ['factory', 'pydenticon', 'faker']
...@@ -192,24 +188,11 @@ doctest_test_doctest_blocks = '' ...@@ -192,24 +188,11 @@ doctest_test_doctest_blocks = ''
# -- intersphinx --- # -- intersphinx ---
intersphinx_mapping = { intersphinx_mapping = {
'python': ('https://docs.python.org/3.7', None), 'python': ('https://docs.python.org/3.7', None),
'django': ('https://docs.djangoproject.com/en/2.1/', 'django': ('https://docs.djangoproject.com/en/2.2/',
'https://docs.djangoproject.com/en/2.1/_objects/'), 'https://docs.djangoproject.com/en/2.2/_objects/'),
} }
# -- Supress warnings --- # -- Supress warnings ---
suppress_warnings = [ suppress_warnings = [
'image.nonlocal_uri', 'image.nonlocal_uri',
] ]
# Hotfix for problems with name clashes in references
# https://github.com/sphinx-doc/sphinx/issues/3866
from sphinx.domains.python import PythonDomain
class PatchedPythonDomain(PythonDomain):
def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
if 'refspecific' in node:
del node['refspecific']
return super(PatchedPythonDomain, self).resolve_xref(
env, fromdocname, builder, typ, target, node, contnode)
def setup(sphinx):
sphinx.override_domain(PatchedPythonDomain)
...@@ -2,16 +2,16 @@ documents package ...@@ -2,16 +2,16 @@ documents package
================= =================
.. automodule:: documents .. automodule:: documents
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Subpackages Subpackages
----------- -----------
.. toctree:: .. toctree::
documents.templatetags documents.templatetags
Submodules Submodules
---------- ----------
...@@ -20,64 +20,63 @@ documents.admin module ...@@ -20,64 +20,63 @@ documents.admin module
---------------------- ----------------------
.. automodule:: documents.admin .. automodule:: documents.admin
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
documents.apps module documents.apps module
--------------------- ---------------------
.. automodule:: documents.apps .. automodule:: documents.apps
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
documents.forms module documents.forms module
---------------------- ----------------------
.. automodule:: documents.forms .. automodule:: documents.forms
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
documents.models module documents.models module
----------------------- -----------------------
.. automodule:: documents.models .. automodule:: documents.models
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
documents.services module documents.services module
------------------------- -------------------------
.. automodule:: documents.services .. automodule:: documents.services
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
documents.sitemaps module documents.sitemaps module
------------------------- -------------------------
.. automodule:: documents.sitemaps .. automodule:: documents.sitemaps
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
documents.urls module documents.urls module
--------------------- ---------------------
.. automodule:: documents.urls .. automodule:: documents.urls
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
documents.views module documents.views module
---------------------- ----------------------
.. automodule:: documents.views .. automodule:: documents.views
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
...@@ -2,9 +2,9 @@ documents.templatetags package ...@@ -2,9 +2,9 @@ documents.templatetags package
============================== ==============================
.. automodule:: documents.templatetags .. automodule:: documents.templatetags
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Submodules Submodules
---------- ----------
...@@ -13,16 +13,15 @@ documents.templatetags.document\_cards module ...@@ -13,16 +13,15 @@ documents.templatetags.document\_cards module
--------------------------------------------- ---------------------------------------------
.. automodule:: documents.templatetags.document_cards .. automodule:: documents.templatetags.document_cards
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
documents.templatetags.filename module documents.templatetags.filename module
-------------------------------------- --------------------------------------
.. automodule:: documents.templatetags.filename .. automodule:: documents.templatetags.filename
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
...@@ -2,9 +2,9 @@ education package ...@@ -2,9 +2,9 @@ education package
================= =================
.. automodule:: education .. automodule:: education
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Submodules Submodules
---------- ----------
...@@ -13,56 +13,55 @@ education.admin module ...@@ -13,56 +13,55 @@ education.admin module
---------------------- ----------------------
.. automodule:: education.admin .. automodule:: education.admin
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
education.apps module education.apps module
--------------------- ---------------------