Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
beat
beat.cmdline
Commits
8b1f44b4
Commit
8b1f44b4
authored
Feb 20, 2019
by
André Anjos
💬
Browse files
[doc] Update sphinx configuration to remove hardcoded urls
parent
043aef51
Changes
1
Hide whitespace changes
Inline
Side-by-side
doc/conf.py
View file @
8b1f44b4
...
...
@@ -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
=
{
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment