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
|
import os
from os.path import join, dirname, abspath
from datetime import datetime
import alabaster
# Alabaster theme + mini-extension
html_theme_path = [alabaster.get_path()]
extensions = ["alabaster", "sphinx.ext.intersphinx"]
# Paths relative to invoking conf.py - not this shared file
html_static_path = [join("..", "_shared_static")]
html_theme = "alabaster"
html_theme_options = {
"logo": "logo.png",
"logo_name": True,
"logo_text_align": "center",
"description": "Pythonic remote execution",
"github_user": "fabric",
"github_repo": "fabric",
"travis_button": True,
"codecov_button": True,
"tidelift_url": "https://tidelift.com/subscription/pkg/pypi-fabric?utm_source=pypi-fabric&utm_medium=referral&utm_campaign=docs",
# "analytics_id": "UA-18486793-1",
"link": "#3782BE",
"link_hover": "#3782BE",
# Wide enough that 80-col code snippets aren't truncated on default font
# settings (at least for bitprophet's Chrome-on-OSX-Yosemite setup)
"page_width": "1024px",
}
html_sidebars = {
"**": ["about.html", "navigation.html", "searchbox.html", "donate.html"]
}
# Enable & configure doctest
extensions.append("sphinx.ext.doctest")
doctest_global_setup = r"""
from fabric.testing.base import MockRemote, MockSFTP, Session, Command
"""
on_rtd = os.environ.get("READTHEDOCS") == "True"
on_travis = os.environ.get("TRAVIS", False)
on_dev = not (on_rtd or on_travis)
# Invoke (docs + www)
inv_target = join(
dirname(__file__), "..", "..", "invoke", "sites", "docs", "_build"
)
if not on_dev:
inv_target = "http://docs.pyinvoke.org/en/latest/"
inv_www_target = join(
dirname(__file__), "..", "..", "invoke", "sites", "www", "_build"
)
if not on_dev:
inv_www_target = "http://pyinvoke.org/"
# Paramiko (docs)
para_target = join(
dirname(__file__), "..", "..", "paramiko", "sites", "docs", "_build"
)
if not on_dev:
para_target = "http://docs.paramiko.org/en/latest/"
intersphinx_mapping = {
"python": ("http://docs.python.org/", None),
"invoke": (inv_target, None),
"invoke_www": (inv_www_target, None),
"paramiko": (para_target, None),
}
# Regular settings
project = "Fabric"
year = datetime.now().year
copyright = "%d Jeff Forcier" % year
master_doc = "index"
templates_path = ["_templates"]
exclude_trees = ["_build"]
source_suffix = ".rst"
default_role = "obj"
|
