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
|
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import sys
sys.path.append("../../")
import rtree # noqa: E402
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "Rtree"
copyright = "2019, Sean Gilles, Howard Butler, and contributors"
author = "Sean Gilles, Howard Butler, and contributors"
version = release = rtree.__version__
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.ifconfig",
"sphinx_issues",
]
templates_path = ["_templates"]
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "nature"
htmlhelp_basename = "Rtreedoc"
# -- Options for LaTeX output --------------------------------------------
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [("index", "Rtree.tex", "Rtree Documentation", author, "manual")]
pdf_documents = [("index", "Rtree", "Rtree Documentation", "The Rtree Team")]
pdf_language = "en_US"
pdf_fit_mode = "overflow"
# -- Extension configuration -------------------------------------------------
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
# sphinx.ext.autodoc
autodoc_typehints = "description"
autodoc_typehints_description_target = "documented"
# sphinx-issues
issues_github_path = "Toblerity/rtree"
issues_commit_prefix = ""
|
