dorian
/
paramiko
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Set up Intersphinx so www can ref docs

This commit is contained in:
Jeff Forcier 2014-01-23 11:43:34 -08:00
parent dde21a7de0
commit 87cd72c144
2 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sites/shared_conf.py
View File

@ -42,7 +42,7 @@ html_sidebars = {
# Regular settings # Regular settings
project = u'Paramiko' project = u'Paramiko'
year = datetime.now().year year = datetime.now().year
copyright = u'%d Jeff Forcier, 2003-2012 Robey Pointer' % year copyright = u'2013-%d Jeff Forcier, 2003-2012 Robey Pointer' % year
master_doc = 'index' master_doc = 'index'
templates_path = ['_templates'] templates_path = ['_templates']
exclude_trees = ['_build'] exclude_trees = ['_build']

25
sites/www/conf.py
View File

@ -1,15 +1,30 @@
# Obtain shared config values # Obtain shared config values
import os, sys import sys
sys.path.append(os.path.abspath('..')) import os
from os.path import abspath, join, dirname
sys.path.append(abspath(join(dirname(__file__), '..')))
from shared_conf import * from shared_conf import *
# Add local blog extension # Local blog extension
sys.path.append(os.path.abspath('.')) sys.path.append(abspath('.'))
extensions = ['blog'] extensions = ['blog']
rss_link = 'http://paramiko.org' rss_link = 'http://paramiko.org'
rss_description = 'Paramiko project news' rss_description = 'Paramiko project news'
# Add Releases changelog extension # Releases changelog extension
extensions.append('releases') extensions.append('releases')
releases_release_uri = "https://github.com/paramiko/paramiko/tree/%s" releases_release_uri = "https://github.com/paramiko/paramiko/tree/%s"
releases_issue_uri = "https://github.com/paramiko/paramiko/issues/%s" releases_issue_uri = "https://github.com/paramiko/paramiko/issues/%s"
# 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':
# TODO: switch to docs.paramiko.org post go-live
target = 'http://paramiko-docs.readthedocs.org/en/latest/'
intersphinx_mapping = {
'docs': (target, None),
}