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
|
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# 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
from datetime import datetime
DOCDIR = os.path.pardir(os.path.abspath(__file__))
sys.path.insert(0, os.path.join(os.path.pardir(DOCDIR), 'getmac'))
from recommonmark.transform import AutoStructify # noqa: E402
import getmac # noqa: E402
# -- Project information -----------------------------------------------------
project = 'getmac'
copyright = '2017 - %i, Christopher Goes' % datetime.today().year
author = 'Christopher Goes'
version = getmac.__version__
release = getmac.__version__
# -- General configuration ---------------------------------------------------
# TODO: sphinx-copybutton
# TODO: sphinx-tabs (or another extension) to provide tabbed command
# examples for different platforms (e.g. for developer docs and CLI usage)
# TODO(python3): sphinx-autodoc-typehints
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
]
# TODO: setup ReadTheDocs
# TODO: convert docs to RST format
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
source_suffix = ['.md'] # , '.rst'
# The master toctree document.
master_doc = 'index'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' # None
# -- Options for HTML output -------------------------------------------------
# TODO: furo theme? (like the pip documentation)
html_theme = 'sphinx_rtd_theme'
# 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".
html_static_path = [] # '_static'
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
html_sidebars = {
'**': [
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
]
}
html_context = {
"display_github": True, # Integrate GitHub
"github_user": "GhostofGoes", # Username
"github_repo": "getmac", # Repo name
"github_version": "main", # Version
"conf_py_path": "/", # Path in the checkout to the docs root
}
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
# TODO: auto-build and include the man page in the release archive
man_pages = [
(master_doc, 'getmac', 'Cross-platform Python package to get MAC addresses',
[author], 1)
]
# -- Extension configuration -------------------------------------------------
def setup(app):
app.add_config_value('recommonmark_config', {
'auto_toc_tree_section': 'Contents',
'enable_eval_rst': True,
'enable_auto_doc_ref': True,
}, True)
app.add_transform(AutoStructify)
|
