Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
thalia
concrexit
Commits
7d518519
Unverified
Commit
7d518519
authored
Jun 17, 2019
by
Thom Wiggers
📐
Browse files
Update dependency sphinx to ~2.1
* Update generated docs with 2.1.1 * Fix configuration issues
parent
676825d4
Changes
40
Hide whitespace changes
Inline
Side-by-side
docs/activemembers.api.rst
View file @
7d518519
...
...
@@ -2,9 +2,9 @@ activemembers.api package
=========================
.. automodule:: activemembers.api
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
...
...
@@ -13,32 +13,31 @@ activemembers.api.permissions module
------------------------------------
.. automodule:: activemembers.api.permissions
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.api.serializers module
------------------------------------
.. automodule:: activemembers.api.serializers
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.api.urls module
-----------------------------
.. automodule:: activemembers.api.urls
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.api.views module
------------------------------
.. automodule:: activemembers.api.views
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
docs/activemembers.rst
View file @
7d518519
...
...
@@ -2,16 +2,16 @@ activemembers package
=====================
.. automodule:: activemembers
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
activemembers.api
activemembers.api
Submodules
----------
...
...
@@ -20,64 +20,63 @@ activemembers.admin module
--------------------------
.. automodule:: activemembers.admin
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.apps module
-------------------------
.. automodule:: activemembers.apps
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.backends module
-----------------------------
.. automodule:: activemembers.backends
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.forms module
--------------------------
.. automodule:: activemembers.forms
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.models module
---------------------------
.. automodule:: activemembers.models
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.sitemaps module
-----------------------------
.. automodule:: activemembers.sitemaps
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.urls module
-------------------------
.. automodule:: activemembers.urls
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
activemembers.views module
--------------------------
.. automodule:: activemembers.views
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
docs/announcements.rst
View file @
7d518519
...
...
@@ -2,9 +2,9 @@ announcements package
=====================
.. automodule:: announcements
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
...
...
@@ -13,48 +13,47 @@ announcements.admin module
--------------------------
.. automodule:: announcements.admin
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
announcements.apps module
-------------------------
.. automodule:: announcements.apps
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
announcements.context\_processors module
----------------------------------------
.. automodule:: announcements.context_processors
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
announcements.models module
---------------------------
.. automodule:: announcements.models
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
announcements.urls module
-------------------------
.. automodule:: announcements.urls
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
announcements.views module
--------------------------
.. automodule:: announcements.views
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
docs/conf.py
View file @
7d518519
...
...
@@ -24,7 +24,6 @@ sys.path.insert(0, os.path.abspath('../website'))
import
django
from
django.conf
import
settings
# noqa
from
recommonmark.parser
import
CommonMarkParser
# noqa
from
thaliawebsite
import
settings
as
thalia_settings
# noqa
...
...
@@ -50,24 +49,18 @@ extensions = [
'sphinx.ext.viewcode'
,
'sphinx.ext.intersphinx'
,
'sphinx.ext.graphviz'
,
'recommonmark'
,
]
# 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_parsers
=
{
'.md'
:
CommonMarkParser
,
}
source_suffix
=
[
'.rst'
,
'.md'
]
# The master toctree document.
master_doc
=
'index'
# General information about the project.
project
=
'Concrexit'
copyright
=
"2017, Technicie, Studievereniging Thalia"
copyright
=
"2017
--2019
, Technicie, Studievereniging Thalia"
author
=
"Technicie, Studievereniging Thalia"
# The version info for the project you're documenting, acts as replacement for
...
...
@@ -178,8 +171,11 @@ texinfo_documents = [
# -- Options for autodoc --------------------------------------------------
# Default flags for autodoc, saves typing
autodoc_default_flags
=
[
'members'
,
'undoc-members'
]
# Default options for autodoc
autodoc_default_options
=
{
'members'
:
True
,
'undoc-members'
:
True
,
}
# We need to mock the modules for the sphinx build in the docker.
autodoc_mock_imports
=
[
'factory'
,
'pydenticon'
,
'faker'
]
...
...
@@ -192,24 +188,11 @@ doctest_test_doctest_blocks = ''
# -- intersphinx ---
intersphinx_mapping
=
{
'python'
:
(
'https://docs.python.org/3.7'
,
None
),
'django'
:
(
'https://docs.djangoproject.com/en/2.
1
/'
,
'https://docs.djangoproject.com/en/2.
1
/_objects/'
),
'django'
:
(
'https://docs.djangoproject.com/en/2.
2
/'
,
'https://docs.djangoproject.com/en/2.
2
/_objects/'
),
}
# -- Supress warnings ---
suppress_warnings
=
[
'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
)
docs/documents.rst
View file @
7d518519
...
...
@@ -2,16 +2,16 @@ documents package
=================
.. automodule:: documents
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
documents.templatetags
documents.templatetags
Submodules
----------
...
...
@@ -20,64 +20,63 @@ documents.admin module
----------------------
.. automodule:: documents.admin
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
documents.apps module
---------------------
.. automodule:: documents.apps
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
documents.forms module
----------------------
.. automodule:: documents.forms
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
documents.models module
-----------------------
.. automodule:: documents.models
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
documents.services module
-------------------------
.. automodule:: documents.services
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
documents.sitemaps module
-------------------------
.. automodule:: documents.sitemaps
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
documents.urls module
---------------------
.. automodule:: documents.urls
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
documents.views module
----------------------
.. automodule:: documents.views
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
docs/documents.templatetags.rst
View file @
7d518519
...
...
@@ -2,9 +2,9 @@ documents.templatetags package
==============================
.. automodule:: documents.templatetags
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
...
...
@@ -13,16 +13,15 @@ documents.templatetags.document\_cards module
---------------------------------------------
.. automodule:: documents.templatetags.document_cards
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
documents.templatetags.filename module
--------------------------------------
.. automodule:: documents.templatetags.filename
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
docs/education.rst
View file @
7d518519
...
...
@@ -2,9 +2,9 @@ education package
=================
.. automodule:: education
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
...
...
@@ -13,56 +13,55 @@ education.admin module
----------------------
.. automodule:: education.admin
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
education.apps module
---------------------
.. automodule:: education.apps
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
education.forms module
----------------------
.. automodule:: education.forms
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
education.models module
-----------------------
.. automodule:: education.models
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
education.sitemaps module
-------------------------
.. automodule:: education.sitemaps
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
education.urls module
---------------------
.. automodule:: education.urls
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
education.views module
----------------------
.. automodule:: education.views
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
docs/events.api.rst
View file @
7d518519
...
...
@@ -2,9 +2,9 @@ events.api package
==================
.. automodule:: events.api
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
...
...
@@ -13,32 +13,31 @@ events.api.permissions module
-----------------------------
.. automodule:: events.api.permissions
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
events.api.serializers module
-----------------------------
.. automodule:: events.api.serializers
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
events.api.urls module
----------------------
.. automodule:: events.api.urls
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
events.api.viewsets module
--------------------------
.. automodule:: events.api.viewsets
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
docs/events.rst
View file @
7d518519
...
...
@@ -2,16 +2,16 @@ events package
==============
.. automodule:: events
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
events.api
events.api
Submodules
----------
...
...
@@ -20,112 +20,111 @@ events.admin module
-------------------
.. automodule:: events.admin
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
events.admin\_views module
--------------------------
.. automodule:: events.admin_views
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
events.apps module
------------------
.. automodule:: events.apps