File: conf.py

package info (click to toggle)
python-awair 0.2.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,088 kB
  • sloc: python: 1,091; makefile: 12
file content (50 lines) | stat: -rw-r--r-- 1,182 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
"""Sphinx configuration for python_awair."""

# pylint: skip-file
import os
import sys

import sphinx_readable_theme

sys.path.insert(0, os.path.abspath(".."))

project = "python_awair"
copyright = "2019-2020, Andrew Hayworth"
author = "Andrew Hayworth"

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    # "sphinx.ext.linkcode",
    "sphinx.ext.viewcode",
    "sphinx.ext.intersphinx",
    "sphinx.ext.todo",
]
templates_path = ["_templates"]

todo_include_todos = True

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

html_theme_path = [sphinx_readable_theme.get_html_theme_path()]
html_theme = "readable"

html_static_path = ["_static"]

intersphinx_mapping = {"aiohttp": ("https://aiohttp.readthedocs.io/en/stable/", None)}

master_doc = "index"


def linkcode_resolve(domain, info):  # type: ignore
    """Return github.com link for module."""
    if domain != "py" or "module" not in info:
        return None

    filename = info["module"].replace(".", "/")
    if filename == "python_awair":
        filename += "/__init__.py"
    else:
        filename += ".py"

    return "https://github.com/ahayworth/python_awair/tree/master/" + filename