conf.py 6.45 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Concrexit documentation build configuration file, created by
# sphinx-quickstart on Fri Feb  3 16:04:30 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys

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


# -- Initialise Django ----------------------------------------------------

settings.configure(thalia_settings)
django.setup()

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# 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',
Thom Wiggers's avatar
Thom Wiggers committed
48
    'sphinx.ext.doctest',
49
    'sphinx.ext.mathjax',
Thom Wiggers's avatar
Thom Wiggers committed
50
51
52
    'sphinx.ext.viewcode',
    'sphinx.ext.intersphinx',
]
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# 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"
author = "Technicie, Studievereniging Thalia"

# 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 = None

# 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', 'Thumbs.db', '.DS_Store']

# 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 = False

Thom Wiggers's avatar
Thom Wiggers committed
99
100
# default domain:
primary_domain = 'py'
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

# -- 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".
Thom Wiggers's avatar
Thom Wiggers committed
118
#html_static_path = ['_static']
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'Concrexitdoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'Concrexit.tex', 'Concrexit Documentation',
     'Thom Wiggers, Luuk Scholten, Joost Rijneveld', 'manual'),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'concrexit', 'Concrexit Documentation',
     [author], 1)
]


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'Concrexit', 'Concrexit Documentation',
     author, 'Concrexit', "Thalia's website",
     'Django Applications'),
]

# -- Options for autodoc --------------------------------------------------

# Default flags for autodoc, saves typing
autodoc_default_flags = ['members', 'undoc-members']
Thom Wiggers's avatar
Thom Wiggers committed
181

182
183
184
# We need to mock the modules for the sphinx build in the docker.
autodoc_mock_imports = ['factory', 'pydenticon', 'faker']

Thom Wiggers's avatar
Thom Wiggers committed
185
186
187
188
# -- Options for doctest --------------------------------------------------

# Disable doctests in normal strings
doctest_test_doctest_blocks = ''
Thom Wiggers's avatar
Thom Wiggers committed
189

Thom Wiggers's avatar
Thom Wiggers committed
190
# -- intersphinx ---
Thom Wiggers's avatar
Thom Wiggers committed
191
192
193
194
195
intersphinx_mapping = {
        'python': ('https://docs.python.org/3.6', None),
        'django': ('https://docs.djangoproject.com/en/2.0/',
                   'https://docs.djangoproject.com/en/2.0/_objects/'),
}
Thom Wiggers's avatar
Thom Wiggers committed
196

Thom Wiggers's avatar
Thom Wiggers committed
197
198
199
200
# -- Supress warnings  ---
suppress_warnings = [
    'image.nonlocal_uri',
]
201
202
203
204
205
206
207
208
209
210
211
212
213

# 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)