2014-01-13 15:17:46 -05:00
|
|
|
# Obtain shared config values
|
2014-01-23 14:43:34 -05:00
|
|
|
import sys
|
|
|
|
import os
|
|
|
|
from os.path import abspath, join, dirname
|
|
|
|
|
|
|
|
sys.path.append(abspath(join(dirname(__file__), '..')))
|
2014-01-13 15:17:46 -05:00
|
|
|
from shared_conf import *
|
2014-01-22 13:55:39 -05:00
|
|
|
|
2014-01-23 14:43:34 -05:00
|
|
|
# Releases changelog extension
|
2014-01-22 15:48:32 -05:00
|
|
|
extensions.append('releases')
|
2014-04-01 15:36:21 -04:00
|
|
|
# Paramiko 1.x tags start with 'v'. Meh.
|
|
|
|
releases_release_uri = "https://github.com/paramiko/paramiko/tree/v%s"
|
2014-01-22 15:48:32 -05:00
|
|
|
releases_issue_uri = "https://github.com/paramiko/paramiko/issues/%s"
|
2014-01-23 14:43:34 -05:00
|
|
|
|
|
|
|
# Intersphinx for referencing API/usage docs
|
|
|
|
extensions.append('sphinx.ext.intersphinx')
|
|
|
|
# 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':
|
2014-01-29 17:24:54 -05:00
|
|
|
# TODO: switch to docs.paramiko.org post go-live of sphinx API docs
|
2014-03-03 21:22:33 -05:00
|
|
|
target = 'http://docs.paramiko.org/en/latest/'
|
2014-04-14 10:48:33 -04:00
|
|
|
intersphinx_mapping['docs'] = (target, None)
|
2014-01-29 17:23:46 -05:00
|
|
|
|
|
|
|
# Sister-site links to API docs
|
|
|
|
html_theme_options['extra_nav_links'] = {
|
|
|
|
"API Docs": 'http://docs.paramiko.org',
|
|
|
|
}
|