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
48
49
50
51
52
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
# -*- coding: utf-8 -*-
#
"""Conf file for isbg docs using sphinx."""
import re
from ast import literal_eval
import os
import sys
import recommonmark
# -- Custom variables -----------------------------------------------------
cvar_gitlab_base_uri = 'https://gitlab.com/'
cvar_gitlab_prj = 'isbg'
cvar_gitlab_usr = 'isbg'
cvar_gitlab_uri = cvar_gitlab_base_uri + cvar_gitlab_prj + '/' + \
cvar_gitlab_usr
cvar_pypi_uri = 'https://pypi.python.org/pypi/isbg'
master_doc = 'index' # The master toctree document.
project = u'isbg'
copyright = u'''License GPLv3: GNU GPL version 3 https://gnu.org/licenses/gpl.html
This is free software: you are free to change and redistribute it. There is
NO WARRANTY, to the extent permitted by law.'''
author = u'''See the CONTRIBUTORS file in the git repository for more
information on who wrote and maintains this software'''
# We get the version from isbg/isbg.py
_VERSION_RE = re.compile(r'__version__\s+=\s+(.*)')
with open('../isbg/isbg.py', 'rb') as f:
_VERSION = str(literal_eval(_VERSION_RE.search(
f.read().decode('utf-8')).group(1)))
sys.path.insert(0, os.path.abspath('..'))
# -- Extensions -----------------------------------------------------------
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.extlinks',
'sphinx.ext.autosummary',
'sphinx.ext.todo'
]
source_suffix = ['.rst']
version = _VERSION
release = _VERSION
pygments_style = 'sphinx'
# -- Options for todo extension -------------------------------------------
todo_include_todos = True
# -- Options for autodoc extension ----------------------------------------
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members']
autodoc_docstring_signature = False
autodoc_mock_imports = []
autodoc_warningiserror = True
autodoc_default_options = {'exclude-members': 'xdg_cache_home'}
# Enable nitpicky mode - which ensures that all references in the docs
# resolve.
nitpicky = True
nitpick_ignore = []
for line in open('nitpick-exceptions'):
if line.strip() == "" or line.startswith("#"):
continue
dtype, target = line.split(None, 1)
target = target.strip()
nitpick_ignore.append((dtype, target))
# -- Options for napoleon extension ---------------------------------------
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = True
napoleon_use_admonition_for_references = True
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True
# -- Options for extlinks extension ---------------------------------------
extlinks = {
'issue': (cvar_gitlab_uri + '/issues/%s', 'issue '), # e.g. :issue:`12`
'pull': (cvar_gitlab_uri + '/pull/%s', 'pull ') # e.g. :pull:`11`
}
# -- Options for HTML output ----------------------------------------------
html_theme = 'sphinx_rtd_theme'
# For theme 'sphinx_rtd_theme':
html_theme_options = {
'canonical_url': '',
'analytics_id': '',
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'collapse_navigation': False,
'sticky_navigation': True,
'navigation_depth': 3,
}
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'searchbox.html',
'relations.html',
]
}
# -- Options for HTMLHelp output ------------------------------------------
htmlhelp_basename = 'isbgdoc'
# -- Options for manual page output ---------------------------------------
man_pages = [
('manpage.isbg', 'isbg', u'scans an IMAP Inbox and runs every entry ' +
u'against SpamAssassin.',
[author], 1),
('manpage.isbg_sa_unwrap', 'isbg_sa_unwrap', u'unwraps a email bundeled ' +
u'by SpamAssassin.',
[author], 1),
]
intersphinx_mapping = {'python': ('https://docs.python.org/3/', None)}
# -- Generate the documentation from sources -----
def run_apidoc(_):
"""Run apidoc."""
from sphinx.ext.apidoc import main
import os
import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
cur_dir = os.path.abspath(os.path.dirname(__file__))
module = os.path.join(cur_dir, "..", project)
params = ['-e', '--force', '--separate', '--private', '--follow-links',
'-o', cur_dir, module]
main(params)
def import_rsts(_):
"""Copy rst files from base dir to cur dir."""
import glob
import shutil
import os
import sys
cur_dir = os.path.abspath(os.path.dirname(__file__))
for file in glob.glob('../*.rst'):
shutil.copy2(file, cur_dir)
def import_mds(_):
"""Copy md files from base dir to cur dir."""
import glob
import shutil
import os
import sys
cur_dir = os.path.abspath(os.path.dirname(__file__))
for file in glob.glob('../*.md'):
shutil.copy2(file, cur_dir)
def setup(app):
"""Configure sphinx."""
app.connect('builder-inited', run_apidoc)
app.connect('builder-inited', import_rsts)
|
