File: conf.py

package info (click to toggle)
aiocoap 0.4.17-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,040 kB
  • sloc: python: 17,241; makefile: 23; sh: 9
file content (66 lines) | stat: -rw-r--r-- 1,509 bytes parent folder | download
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
# SPDX-FileCopyrightText: Christian Amsüss and the aiocoap contributors
#
# SPDX-License-Identifier: MIT

import sys
import os

# for aiocoap_index.py
sys.path.insert(0, os.path.abspath("."))
# for aiocoap.meta
sys.path.insert(0, os.path.abspath(".."))

import aiocoap.meta

extensions = [
    "sphinx.ext.autodoc",
    "aiocoap_index",
    "sphinxarg.ext",
]

exclude_patterns = ["pyodide.rst"]

source_suffix = ".rst"

# This is renamed and already has the default "index" in later Sphinx versions,
# but so far readthedocs renders this with Sphinx 1 (this is more easily
# addressed after an update to use pyproject.toml)
master_doc = "index"

project = "aiocoap"
copyright = "Christian Amsüss and the aiocoap contributors"

# The full version, including alpha/beta/rc tags.
release = aiocoap.meta.version
# The short X.Y version.
version = ".".join(release.split(".")[:2])

html_logo = "logo.svg"
html_favicon = "logo-square.svg"

autodoc_member_order = "bysource"

man_pages = [
    (
        "module/aiocoap.cli.client",
        "aiocoap-client",
        "query CoAP servers from the command line",
        "",
        1,
    ),
    (
        "module/aiocoap.cli.proxy",
        "aiocoap-proxy",
        "forward and reverse proxy server for CoAP",
        "",
        1,
    ),
    ("module/aiocoap.cli.rd", "aiocoap-rd", "Resource Directory server", "", 1),
    (
        "module/aiocoap.cli.fileserver",
        "aiocoap-fileserver",
        "File server for CoAP",
        "",
        1,
    ),
]