Errything uses intersphinx to Python

This commit is contained in:
Jeff Forcier 2014-04-14 10:48:33 -04:00
parent 4fe3ad2220
commit a1c2a9829a
3 changed files with 8 additions and 10 deletions

View File

@ -5,16 +5,11 @@ sys.path.append(os.path.abspath('../..'))
from shared_conf import * from shared_conf import *
# Enable autodoc, intersphinx # Enable autodoc, intersphinx
extensions.extend(['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']) extensions.extend(['sphinx.ext.autodoc'])
# Autodoc settings # Autodoc settings
autodoc_default_flags = ['members', 'special-members'] autodoc_default_flags = ['members', 'special-members']
# Intersphinx connection to stdlib
intersphinx_mapping = {
'python': ('http://docs.python.org/2.6', None),
}
# Sister-site links to WWW # Sister-site links to WWW
html_theme_options['extra_nav_links'] = { html_theme_options['extra_nav_links'] = {
"Main website": 'http://www.paramiko.org', "Main website": 'http://www.paramiko.org',

View File

@ -5,7 +5,7 @@ import alabaster
# Alabaster theme + mini-extension # Alabaster theme + mini-extension
html_theme_path = [alabaster.get_path()] html_theme_path = [alabaster.get_path()]
extensions = ['alabaster'] extensions = ['alabaster', 'sphinx.ext.intersphinx']
# Paths relative to invoking conf.py - not this shared file # Paths relative to invoking conf.py - not this shared file
html_theme = 'alabaster' html_theme = 'alabaster'
html_theme_options = { html_theme_options = {
@ -24,6 +24,11 @@ html_sidebars = {
] ]
} }
# Everything intersphinx's to Python
intersphinx_mapping = {
'python': ('http://docs.python.org/2.6', None),
}
# Regular settings # Regular settings
project = 'Paramiko' project = 'Paramiko'
year = datetime.now().year year = datetime.now().year

View File

@ -25,9 +25,7 @@ target = join(dirname(__file__), '..', 'docs', '_build')
if os.environ.get('READTHEDOCS') == 'True': if os.environ.get('READTHEDOCS') == 'True':
# TODO: switch to docs.paramiko.org post go-live of sphinx API docs # TODO: switch to docs.paramiko.org post go-live of sphinx API docs
target = 'http://docs.paramiko.org/en/latest/' target = 'http://docs.paramiko.org/en/latest/'
intersphinx_mapping = { intersphinx_mapping['docs'] = (target, None)
'docs': (target, None),
}
# Sister-site links to API docs # Sister-site links to API docs
html_theme_options['extra_nav_links'] = { html_theme_options['extra_nav_links'] = {