Commit b3c30ddd authored by André Anjos's avatar André Anjos 💬

Update sphinx doc

parent 449c3477
Pipeline #4322 failed with stage
in 1 minute and 35 seconds
......@@ -42,16 +42,16 @@ nitpick_ignore = []
# Allows the user to override warnings from a separate file
if os.path.exists('nitpick-exceptions.txt'):
for line in open('nitpick-exceptions.txt'):
if line.strip() == "" or line.startswith("#"):
continue
dtype, target = line.split(None, 1)
target = target.strip()
try: # python 2.x
target = unicode(target)
except NameError:
pass
nitpick_ignore.append((dtype, target))
for line in open('nitpick-exceptions.txt'):
if line.strip() == "" or line.startswith("#"):
continue
dtype, target = line.split(None, 1)
target = target.strip()
try: # python 2.x
target = unicode(target)
except NameError:
pass
nitpick_ignore.append((dtype, target))
# Always includes todos
todo_include_todos = True
......@@ -79,7 +79,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'gridtk'
project = u'<PROJECT>'
import time
copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')
......@@ -131,7 +131,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
short_description = u'Parallel Job Manager'
short_description = u'<SHORT_DESCRIPTION>'
owner = [u'Idiap Research Institute']
......@@ -239,14 +239,10 @@ autodoc_default_flags = [
from bob.extension.utils import link_documentation, load_requirements
sphinx_requirements = "extra-intersphinx.txt"
if os.path.exists(sphinx_requirements):
print("Hello, world!")
intersphinx_mapping = link_documentation(additional_packages=load_requirements(sphinx_requirements))
else:
intersphinx_mapping = link_documentation()
# Link SQLAlchemy by hand (not supported by link_documentation())
intersphinx_mapping['sqlalchemy'] = ('http://docs.sqlalchemy.org/en/latest',
None)
# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
......
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