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
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import os
import os.path
# needs_sphinx = '1.0'
extensions = [
"sphinx.ext.ifconfig",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints",
"sphinx_issues",
"recommonmark",
]
templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
project = 'autosuspend'
copyright = '2017, Johannes Wienke'
author = 'Johannes Wienke'
with open(os.path.join(
os.path.abspath(os.path.dirname(os.path.realpath(__file__))),
'../..',
'VERSION'), 'r') as version_file:
lines = version_file.readlines()
version = lines[0].strip()
release = lines[1].strip()
language = "en"
exclude_patterns = []
pygments_style = 'sphinx'
todo_include_todos = False
rst_epilog = '''
.. _autosuspend: https://github.com/languitar/autosuspend
.. _Python 3: https://docs.python.org/3/
.. _Python: https://docs.python.org/3/
.. _setuptools: https://setuptools.readthedocs.io
.. _configparser: https://docs.python.org/3/library/configparser.html
.. _psutil: https://github.com/giampaolo/psutil
.. _lxml: http://lxml.de/
.. _MPD: http://www.musicpd.org/
.. _python-mpd2: https://pypi.python.org/pypi/python-mpd2
.. _dbus-python: https://cgit.freedesktop.org/dbus/dbus-python/
.. _Kodi: https://kodi.tv/
.. _requests: https://pypi.python.org/pypi/requests
.. _systemd: https://www.freedesktop.org/wiki/Software/systemd/
.. _systemd service files: http://www.freedesktop.org/software/systemd/man/systemd.service.html
.. _broadcast-logging: https://github.com/languitar/broadcast-logging
.. _tvheadend: https://tvheadend.org/
.. _XPath: https://www.w3.org/TR/xpath/
.. _logind: https://www.freedesktop.org/wiki/Software/systemd/logind/
.. _iCalendar: https://tools.ietf.org/html/rfc5545
.. _dateutil: https://dateutil.readthedocs.io
.. _python-icalendar: https://icalendar.readthedocs.io
.. _tzlocal: https://pypi.org/project/tzlocal/
.. _requests-file: https://github.com/dashea/requests-file
.. _Plex: https://www.plex.tv/
.. _portalocker: https://portalocker.readthedocs.io
.. _jsonpath-ng: https://github.com/h2non/jsonpath-ng
.. _JSONPath: https://goessner.net/articles/JsonPath/
.. _tzdata: https://pypi.org/project/tzdata/:w
.. |project| replace:: {project}
.. |project_bold| replace:: **{project}**
.. |project_program| replace:: :program:`{project}`'''.format(project=project)
# Intersphinx
intersphinx_mapping = {'python': ('/usr/share/doc/python3-doc/html', None)}
# HTML options
html_theme = 'furo'
# html_theme_options = {}
# html_static_path = ['_static']
html_sidebars = {
}
# MANPAGE options
man_pages = [
('man_command',
'autosuspend',
'autosuspend Documentation',
[author],
1),
('man_config',
'autosuspend.conf',
'autosuspend config file Documentation',
[author],
5),
]
man_show_urls = True
# issues
issues_github_path = 'languitar/autosuspend'
# napoleon
napoleon_google_docstring = True
napoleon_numpye_docstring = False
napoleon_include_init_with_doc = True
typehints_fully_qualified = True
def setup(app):
app.add_config_value(
'is_preview',
os.environ.get('READTHEDOCS_VERSION', '') == 'latest',
'env',
)
|
