Commit 6899a906 authored by Sébastiaan Versteeg's avatar Sébastiaan Versteeg
Browse files

Merge branch 'keep-docs-up-to-date' into 'master'

Check for docs changes

See merge request !643
parents 1ebd5f8a 6d87f1f6
......@@ -44,8 +44,12 @@ docs:
# install doc deps
- pip install -r requirements.txt
script:
- echo "Building current docs"
- env -u GITLAB_CI make doctest
- test -z "$(env -u GITLAB_CI make html | egrep -w 'SEVERE:|ERROR:')"
- env -u GITLAB_CI sphinx-build -M html "." "_build" -W
- echo "Checking if there are changes"
- ./generate-apidocs.sh
- git diff --exit-code
cache:
key: "$CI_JOB_NAME"
......
......@@ -9,64 +9,64 @@ activemembers package
Submodules
----------
activemembers.admin module
--------------------------
activemembers\.admin module
---------------------------
.. automodule:: activemembers.admin
:members:
:undoc-members:
:show-inheritance:
activemembers.apps module
-------------------------
activemembers\.apps module
--------------------------
.. automodule:: activemembers.apps
:members:
:undoc-members:
:show-inheritance:
activemembers.backends module
-----------------------------
activemembers\.backends module
------------------------------
.. automodule:: activemembers.backends
:members:
:undoc-members:
:show-inheritance:
activemembers.forms module
--------------------------
activemembers\.forms module
---------------------------
.. automodule:: activemembers.forms
:members:
:undoc-members:
:show-inheritance:
activemembers.models module
---------------------------
activemembers\.models module
----------------------------
.. automodule:: activemembers.models
:members:
:undoc-members:
:show-inheritance:
activemembers.sitemaps module
-----------------------------
activemembers\.sitemaps module
------------------------------
.. automodule:: activemembers.sitemaps
:members:
:undoc-members:
:show-inheritance:
activemembers.urls module
-------------------------
activemembers\.urls module
--------------------------
.. automodule:: activemembers.urls
:members:
:undoc-members:
:show-inheritance:
activemembers.views module
--------------------------
activemembers\.views module
---------------------------
.. automodule:: activemembers.views
:members:
......
......@@ -9,48 +9,48 @@ announcements package
Submodules
----------
announcements.admin module
--------------------------
announcements\.admin module
---------------------------
.. automodule:: announcements.admin
:members:
:undoc-members:
:show-inheritance:
announcements.apps module
-------------------------
announcements\.apps module
--------------------------
.. automodule:: announcements.apps
:members:
:undoc-members:
:show-inheritance:
announcements.context_processors module
---------------------------------------
announcements\.context\_processors module
-----------------------------------------
.. automodule:: announcements.context_processors
:members:
:undoc-members:
:show-inheritance:
announcements.models module
---------------------------
announcements\.models module
----------------------------
.. automodule:: announcements.models
:members:
:undoc-members:
:show-inheritance:
announcements.urls module
-------------------------
announcements\.urls module
--------------------------
.. automodule:: announcements.urls
:members:
:undoc-members:
:show-inheritance:
announcements.views module
--------------------------
announcements\.views module
---------------------------
.. automodule:: announcements.views
:members:
......
......@@ -47,7 +47,9 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode']
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -94,6 +96,8 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# default domain:
primary_domain = 'py'
# -- Options for HTML output ----------------------------------------------
......@@ -111,7 +115,7 @@ html_theme = 'alabaster'
# 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']
#html_static_path = ['_static']
# -- Options for HTMLHelp output ------------------------------------------
......@@ -179,3 +183,25 @@ autodoc_default_flags = ['members', 'undoc-members']
# Disable doctests in normal strings
doctest_test_doctest_blocks = ''
# -- intersphinx ---
intersphinx_mapping = {'python': ('https://docs.python.org/3.5', None)}
# -- 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)
......@@ -6,58 +6,51 @@ documents package
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
documents.templatetags
Submodules
----------
documents.admin module
----------------------
documents\.admin module
-----------------------
.. automodule:: documents.admin
:members:
:undoc-members:
:show-inheritance:
documents.apps module
---------------------
documents\.apps module
----------------------
.. automodule:: documents.apps
:members:
:undoc-members:
:show-inheritance:
documents.models module
-----------------------
documents\.models module
------------------------
.. automodule:: documents.models
:members:
:undoc-members:
:show-inheritance:
documents.sitemaps module
-------------------------
documents\.sitemaps module
--------------------------
.. automodule:: documents.sitemaps
:members:
:undoc-members:
:show-inheritance:
documents.urls module
---------------------
documents\.urls module
----------------------
.. automodule:: documents.urls
:members:
:undoc-members:
:show-inheritance:
documents.views module
----------------------
documents\.views module
-----------------------
.. automodule:: documents.views
:members:
......
documents.templatetags package
==============================
documents\.templatetags package
===============================
.. automodule:: documents.templatetags
:members:
......@@ -9,8 +9,8 @@ documents.templatetags package
Submodules
----------
documents.templatetags.filename module
--------------------------------------
documents\.templatetags\.filename module
----------------------------------------
.. automodule:: documents.templatetags.filename
:members:
......
......@@ -9,56 +9,56 @@ education package
Submodules
----------
education.admin module
----------------------
education\.admin module
-----------------------
.. automodule:: education.admin
:members:
:undoc-members:
:show-inheritance:
education.apps module
---------------------
education\.apps module
----------------------
.. automodule:: education.apps
:members:
:undoc-members:
:show-inheritance:
education.forms module
----------------------
education\.forms module
-----------------------
.. automodule:: education.forms
:members:
:undoc-members:
:show-inheritance:
education.models module
-----------------------
education\.models module
------------------------
.. automodule:: education.models
:members:
:undoc-members:
:show-inheritance:
education.sitemaps module
-------------------------
education\.sitemaps module
--------------------------
.. automodule:: education.sitemaps
:members:
:undoc-members:
:show-inheritance:
education.urls module
---------------------
education\.urls module
----------------------
.. automodule:: education.urls
:members:
:undoc-members:
:show-inheritance:
education.views module
----------------------
education\.views module
-----------------------
.. automodule:: education.views
:members:
......
events.api package
==================
events\.api package
===================
.. automodule:: events.api
:members:
......@@ -9,32 +9,32 @@ events.api package
Submodules
----------
events.api.permissions module
-----------------------------
events\.api\.permissions module
-------------------------------
.. automodule:: events.api.permissions
:members:
:undoc-members:
:show-inheritance:
events.api.serializers module
-----------------------------
events\.api\.serializers module
-------------------------------
.. automodule:: events.api.serializers
:members:
:undoc-members:
:show-inheritance:
events.api.urls module
----------------------
events\.api\.urls module
------------------------
.. automodule:: events.api.urls
:members:
:undoc-members:
:show-inheritance:
events.api.viewsets module
--------------------------
events\.api\.viewsets module
----------------------------
.. automodule:: events.api.viewsets
:members:
......
......@@ -6,114 +6,107 @@ events package
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
events.api
Submodules
----------
events.admin module
-------------------
events\.admin module
--------------------
.. automodule:: events.admin
:members:
:undoc-members:
:show-inheritance:
events.admin_views module
-------------------------
events\.admin\_views module
---------------------------
.. automodule:: events.admin_views
:members:
:undoc-members:
:show-inheritance:
events.apps module
------------------
events\.apps module
-------------------
.. automodule:: events.apps
:members:
:undoc-members:
:show-inheritance:
events.decorators module
------------------------
events\.decorators module
-------------------------
.. automodule:: events.decorators
:members:
:undoc-members:
:show-inheritance:
events.emails module
--------------------
events\.emails module
---------------------
.. automodule:: events.emails
:members:
:undoc-members:
:show-inheritance:
events.exceptions module
------------------------
events\.exceptions module
-------------------------
.. automodule:: events.exceptions
:members:
:undoc-members:
:show-inheritance:
events.feeds module
-------------------
events\.feeds module
--------------------
.. automodule:: events.feeds
:members:
:undoc-members:
:show-inheritance:
events.forms module
-------------------
events\.forms module
--------------------
.. automodule:: events.forms
:members:
:undoc-members:
:show-inheritance:
events.models module
--------------------
events\.models module
---------------------
.. automodule:: events.models
:members:
:undoc-members:
:show-inheritance:
events.services module
----------------------
events\.services module
-----------------------
.. automodule:: events.services
:members:
:undoc-members:
:show-inheritance:
events.sitemaps module
----------------------
events\.sitemaps module
-----------------------
.. automodule:: events.sitemaps
:members:
:undoc-members:
:show-inheritance:
events.urls module
------------------
events\.urls module
-------------------
.. automodule:: events.urls
:members:
:undoc-members:
:show-inheritance:
events.views module
-------------------
events\.views module
--------------------
.. automodule:: events.views
:members:
......
mailinglists.api package
========================
mailinglists\.api package
=========================
.. automodule:: mailinglists.api
:members:
......@@ -9,32 +9,32 @@ mailinglists.api package
Submodules
----------
mailinglists.api.permissions module
-----------------------------------
mailinglists\.api\.permissions module
-------------------------------------
.. automodule:: mailinglists.api.permissions
:members:
:undoc-members:
:show-inheritance:
mailinglists.api.serializers module
-----------------------------------
mailinglists\.api\.serializers module
-------------------------------------
.. automodule:: mailinglists.api.serializers
:members:
:undoc-members:
:show-inheritance:
mailinglists.api.urls module
----------------------------
mailinglists\.api\.urls module
------------------------------
.. automodule:: mailinglists.api.urls
:members:
:undoc-members:
:show-inheritance:
mailinglists.api.viewsets module
--------------------------------
mailinglists\.api\.viewsets module
----------------------------------
.. automodule:: mailinglists.api.viewsets
:members:
......
......@@ -6,42 +6,35 @@ mailinglists package
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
mailinglists.api
Submodules
----------
mailinglists.admin module
-------------------------
mailinglists\.admin module
--------------------------
.. automodule:: mailinglists.admin
:members:
:undoc-members:
:show-inheritance:
mailinglists.apps module
------------------------
mailinglists\.apps module
-------------------------
.. automodule:: mailinglists.apps
:members:
:undoc-members:
:show-inheritance:
mailinglists.models module
--------------------------
mailinglists\.models module
---------------------------
.. automodule:: mailinglists.models
:members:
:undoc-members:
:show-inheritance:
mailinglists.services module