Skip to content
Snippets Groups Projects
Commit aaf3b5b1 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI Committed by Flavio TARSETTI
Browse files

small modifications to fix some other warnings

parent 9ba992f0
No related branches found
No related tags found
1 merge request!295Fixes some warning issues with the documentation
Pipeline #31607 passed
......@@ -48,6 +48,7 @@ extensions = [
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinxcontrib.programoutput',
'sphinxcontrib.httpdomain',
]
# Always includes todos
......
......@@ -39,7 +39,7 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'beat.web.settings.settings'
from django.core.wsgi import get_wsgi_application
application = get_wsgi_application()
#from django.conf import settings
#settings.configure()
# settings.configure()
# -- General configuration -----------------------------------------------------
......@@ -61,7 +61,7 @@ extensions = [
'sphinx.ext.viewcode',
'sphinxcontrib.programoutput',
'sphinxcontrib.httpdomain',
]
]
# Always includes todos
todo_include_todos = True
......@@ -74,7 +74,8 @@ autosummary_generate = True
# If we are on OSX, the 'dvipng' path maybe different
dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng'
if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx
if os.path.exists(dvipng_osx):
pngmath_dvipng = dvipng_osx
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -118,9 +119,9 @@ release = distribution.version
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = [
'api/modules.rst',
'api/beat.rst',
]
'api/modules.rst',
'api/beat.rst',
]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
......@@ -245,7 +246,7 @@ latex_documents = [(
short_description,
owner[0],
'manual',
)]
)]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
......@@ -288,17 +289,17 @@ man_pages = [(
short_description,
owner,
1,
)]
)]
# Default processing flags for sphinx
autoclass_content = 'class'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
'members',
'undoc-members',
'show-inheritance',
]
'members',
'undoc-members',
'show-inheritance',
]
if not 'BOB_DOCUMENTATION_SERVER' in os.environ:
......@@ -311,8 +312,8 @@ 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))
additional_packages=['python', 'numpy'] +
load_requirements(sphinx_requirements))
else:
intersphinx_mapping = link_documentation()
......
......@@ -31,7 +31,6 @@
introduction
web_api
api/beat.web
Indices and tables
==================
......
......@@ -47,7 +47,8 @@ extensions = [
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinxcontrib.programoutput',
]
'sphinxcontrib.httpdomain',
]
# Be picky about warnings
nitpicky = True
......@@ -62,7 +63,7 @@ if os.path.exists('nitpick-exceptions.txt'):
continue
dtype, target = line.split(None, 1)
target = target.strip()
try: # python 2.x
try: # python 2.x
target = unicode(target)
except NameError:
pass
......@@ -79,7 +80,8 @@ numfig = True
# If we are on OSX, the 'dvipng' path maybe different
dvipng_osx = '/Library/TeX/texbin/dvipng'
if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx
if os.path.exists(dvipng_osx):
pngmath_dvipng = dvipng_osx
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -240,14 +242,14 @@ htmlhelp_basename = project_variable + u'_doc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
'papersize': 'a4paper',
# The paper size ('letterpaper' or 'a4paper').
'papersize': 'a4paper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
'preamble': '\setcounter{tocdepth}{4}',
# Additional stuff for the LaTeX preamble.
'preamble': '\setcounter{tocdepth}{4}',
}
# Grouping the document tree into LaTeX files. List of tuples
......@@ -262,7 +264,7 @@ latex_documents = [(
short_description,
owner[0],
'manual',
)]
)]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
......@@ -283,3 +285,10 @@ latex_documents = [(
# If false, no module index is generated.
#latex_domain_indices = True
rst_epilog = """
.. |project| replace:: BEAT
.. |url| replace:: https://www.beat-eu.org/platform/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)
......@@ -52,6 +52,8 @@ extensions = [
'sphinx.ext.graphviz',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinxcontrib.programoutput',
'sphinxcontrib.httpdomain',
]
# Always includes todos
......
......@@ -66,3 +66,5 @@ button. A pop-up window will appear confirming the modification. You may cancel
the action (i.e., the token won't change), or click on ``Continue``, which will
effectively change the token associated with your account. To display the new
token, click on the ``Show`` button once more.
.. include:: ../links.rst
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment