summaryrefslogtreecommitdiffhomepage
path: root/sites
diff options
context:
space:
mode:
Diffstat (limited to 'sites')
-rw-r--r--sites/docs/conf.py13
-rw-r--r--sites/shared_conf.py39
-rw-r--r--sites/www/conf.py16
3 files changed, 31 insertions, 37 deletions
diff --git a/sites/docs/conf.py b/sites/docs/conf.py
index 5674fed1..eb895804 100644
--- a/sites/docs/conf.py
+++ b/sites/docs/conf.py
@@ -1,16 +1,17 @@
# Obtain shared config values
import os, sys
-sys.path.append(os.path.abspath('..'))
-sys.path.append(os.path.abspath('../..'))
+
+sys.path.append(os.path.abspath(".."))
+sys.path.append(os.path.abspath("../.."))
from shared_conf import *
# Enable autodoc, intersphinx
-extensions.extend(['sphinx.ext.autodoc'])
+extensions.extend(["sphinx.ext.autodoc"])
# Autodoc settings
-autodoc_default_flags = ['members', 'special-members']
+autodoc_default_flags = ["members", "special-members"]
# Sister-site links to WWW
-html_theme_options['extra_nav_links'] = {
- "Main website": 'http://www.paramiko.org',
+html_theme_options["extra_nav_links"] = {
+ "Main website": "http://www.paramiko.org"
}
diff --git a/sites/shared_conf.py b/sites/shared_conf.py
index cf0d77ff..f4806cf1 100644
--- a/sites/shared_conf.py
+++ b/sites/shared_conf.py
@@ -5,36 +5,29 @@ import alabaster
# Alabaster theme + mini-extension
html_theme_path = [alabaster.get_path()]
-extensions = ['alabaster', 'sphinx.ext.intersphinx']
+extensions = ["alabaster", "sphinx.ext.intersphinx"]
# Paths relative to invoking conf.py - not this shared file
-html_theme = 'alabaster'
+html_theme = "alabaster"
html_theme_options = {
- 'description': "A Python implementation of SSHv2.",
- 'github_user': 'paramiko',
- 'github_repo': 'paramiko',
- 'analytics_id': 'UA-18486793-2',
- 'travis_button': True,
+ "description": "A Python implementation of SSHv2.",
+ "github_user": "paramiko",
+ "github_repo": "paramiko",
+ "analytics_id": "UA-18486793-2",
+ "travis_button": True,
}
html_sidebars = {
- '**': [
- 'about.html',
- 'navigation.html',
- 'searchbox.html',
- 'donate.html',
- ]
+ "**": ["about.html", "navigation.html", "searchbox.html", "donate.html"]
}
# Everything intersphinx's to Python
-intersphinx_mapping = {
- 'python': ('https://docs.python.org/2.7/', None),
-}
+intersphinx_mapping = {"python": ("https://docs.python.org/2.7/", None)}
# Regular settings
-project = 'Paramiko'
+project = "Paramiko"
year = datetime.now().year
-copyright = '{} Jeff Forcier'.format(year)
-master_doc = 'index'
-templates_path = ['_templates']
-exclude_trees = ['_build']
-source_suffix = '.rst'
-default_role = 'obj'
+copyright = "{} Jeff Forcier".format(year)
+master_doc = "index"
+templates_path = ["_templates"]
+exclude_trees = ["_build"]
+source_suffix = ".rst"
+default_role = "obj"
diff --git a/sites/www/conf.py b/sites/www/conf.py
index c7ba0a86..00944871 100644
--- a/sites/www/conf.py
+++ b/sites/www/conf.py
@@ -3,22 +3,22 @@ import sys
import os
from os.path import abspath, join, dirname
-sys.path.append(abspath(join(dirname(__file__), '..')))
+sys.path.append(abspath(join(dirname(__file__), "..")))
from shared_conf import *
# Releases changelog extension
-extensions.append('releases')
+extensions.append("releases")
releases_release_uri = "https://github.com/paramiko/paramiko/tree/%s"
releases_issue_uri = "https://github.com/paramiko/paramiko/issues/%s"
# Default is 'local' building, but reference the public docs site when building
# under RTD.
-target = join(dirname(__file__), '..', 'docs', '_build')
-if os.environ.get('READTHEDOCS') == 'True':
- target = 'http://docs.paramiko.org/en/latest/'
-intersphinx_mapping['docs'] = (target, None)
+target = join(dirname(__file__), "..", "docs", "_build")
+if os.environ.get("READTHEDOCS") == "True":
+ target = "http://docs.paramiko.org/en/latest/"
+intersphinx_mapping["docs"] = (target, None)
# Sister-site links to API docs
-html_theme_options['extra_nav_links'] = {
- "API Docs": 'http://docs.paramiko.org',
+html_theme_options["extra_nav_links"] = {
+ "API Docs": "http://docs.paramiko.org"
}