Commit 8b1f44b4 authored by André Anjos's avatar André Anjos 💬

[doc] Update sphinx configuration to remove hardcoded urls

parent 043aef51
......@@ -26,8 +26,6 @@
###############################################################################
import os
import sys
import glob
import pkg_resources
......@@ -88,7 +86,7 @@ autosummary_generate = True
numfig = True
# If we are on OSX, the 'dvipng' path maybe different
dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng'
dvipng_osx = '/Library/TeX/texbin/dvipng'
if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx
# Add any paths that contain templates here, relative to this directory.
......@@ -259,24 +257,20 @@ autodoc_default_flags = [
'show-inheritance',
]
if not 'BOB_DOCUMENTATION_SERVER' in os.environ:
# notice we need to overwrite this for BEAT projects - defaults from Bob are
# not OK
os.environ['BOB_DOCUMENTATION_SERVER'] = "https://www.idiap.ch/software/beat/docs/beat/%(name)s/%(version)s/|https://www.idiap.ch/software/beat/docs/beat/%(name)s/master/"
# For inter-documentation mapping:
doc_server = [
'http://www.idiap.ch/software/beat/docs/beat/%(name)s/%(version)s/',
'http://www.idiap.ch/software/beat/docs/beat/%(name)s/master/',
'http://www.idiap.ch/software/beat/docs/beat/%(name)s/1.6.x/',
'http://www.idiap.ch/software/beat/docs/beat/%(name)s/1.5.x/',
]
doc_server = '|'.join(doc_server)
from bob.extension.utils import link_documentation, load_requirements
sphinx_requirements = "extra-intersphinx.txt"
if os.path.exists(sphinx_requirements):
intersphinx_mapping = link_documentation(
additional_packages=['python','numpy'] + \
load_requirements(sphinx_requirements),
server=doc_server,
)
load_requirements(sphinx_requirements))
else:
intersphinx_mapping = link_documentation(server=doc_server)
intersphinx_mapping = link_documentation()
# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
......@@ -295,7 +289,6 @@ def member_function_test(app, what, name, obj, skip, options):
return skip
return False
# Excludes the "Usage" docstrings from these modules to appear in the API
# documentation
exclude_docstrings = {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment