Commit 9b3097b7 authored by André Anjos's avatar André Anjos 💬

[doc] Re-enable nitpicky mode; Fix broken docs

parent fd77c14a
Pipeline #27311 failed with stage
in 19 minutes and 40 seconds
...@@ -92,8 +92,8 @@ class DataFormat(BackendDataFormat): ...@@ -92,8 +92,8 @@ class DataFormat(BackendDataFormat):
storage (object): A simple object that provides information about file storage (object): A simple object that provides information about file
paths for this dataformat paths for this dataformat
errors (list of str): A list containing errors found while loading this errors (list): A list of strings containing errors found while loading
dataformat. this dataformat.
data (dict): The original data for this dataformat, as loaded by our JSON data (dict): The original data for this dataformat, as loaded by our JSON
decoder. decoder.
......
...@@ -123,11 +123,11 @@ class BaseExecutor(object): ...@@ -123,11 +123,11 @@ class BaseExecutor(object):
for that particular combination of details. The dictionary may be empty for that particular combination of details. The dictionary may be empty
in case all inputs are taken from the file cache. in case all inputs are taken from the file cache.
input_list (beat.core.inputs.InputList): A list of inputs that will be input_list (beat.backend.python.inputs.InputList): A list of inputs that
served to the algorithm. will be served to the algorithm.
output_list (beat.core.outputs.OutputList): A list of outputs that the output_list (beat.backend.python.outputs.OutputList): A list of outputs
algorithm will produce. that the algorithm will produce.
data_sources (list): A list with all data-sources created by our execution data_sources (list): A list with all data-sources created by our execution
loader. loader.
......
...@@ -115,11 +115,11 @@ class RemoteExecutor(BaseExecutor): ...@@ -115,11 +115,11 @@ class RemoteExecutor(BaseExecutor):
for that particular combination of details. The dictionary may be empty for that particular combination of details. The dictionary may be empty
in case all inputs are taken from the file cache. in case all inputs are taken from the file cache.
input_list (beat.core.inputs.InputList): A list of inputs that will be input_list (beat.backend.python.inputs.InputList): A list of inputs that
served to the algorithm. will be served to the algorithm.
output_list (beat.core.outputs.OutputList): A list of outputs that the output_list (beat.backend.python.outputs.OutputList): A list of outputs
algorithm will produce. that the algorithm will produce.
data_sources (list): A list with all data-sources created by our execution data_sources (list): A list with all data-sources created by our execution
loader. loader.
......
...@@ -141,11 +141,11 @@ class SubprocessExecutor(RemoteExecutor): ...@@ -141,11 +141,11 @@ class SubprocessExecutor(RemoteExecutor):
for that particular combination of details. The dictionary may be empty for that particular combination of details. The dictionary may be empty
in case all inputs are taken from the file cache. in case all inputs are taken from the file cache.
input_list (beat.core.inputs.InputList): A list of inputs that will be input_list (beat.backend.python.inputs.InputList): A list of inputs that
served to the algorithm. will be served to the algorithm.
output_list (beat.core.outputs.OutputList): A list of outputs that the output_list (beat.backend.python.outputs.OutputList): A list of outputs
algorithm will produce. that the algorithm will produce.
data_sources (list): A list with all data-sources created by our execution data_sources (list): A list with all data-sources created by our execution
loader. loader.
......
...@@ -164,7 +164,7 @@ class Experiment(object): ...@@ -164,7 +164,7 @@ class Experiment(object):
:py:class:`beat.core.algorithm.Algorithm` pointers for all analyzers in :py:class:`beat.core.algorithm.Algorithm` pointers for all analyzers in
this experiment. this experiment.
errors (list of str): A list containing errors found while loading this errors (list): A list strings containing errors found while loading this
experiment. experiment.
data (dict): The original data for this experiment, as loaded by our JSON data (dict): The original data for this experiment, as loaded by our JSON
......
...@@ -148,7 +148,7 @@ class Plotter(object): ...@@ -148,7 +148,7 @@ class Plotter(object):
storage (object): A simple object that provides information about file storage (object): A simple object that provides information about file
paths for this algorithm paths for this algorithm
dataformat (obj): An object of type :py:class:`.dataformat.DataFormat` dataformat (object): An object of type :py:class:`.dataformat.DataFormat`
that represents the dataformat to which this plotter is applicable. that represents the dataformat to which this plotter is applicable.
libraries (dict): A mapping object defining other libraries this plotter libraries (dict): A mapping object defining other libraries this plotter
......
...@@ -64,7 +64,7 @@ class Statistics(object): ...@@ -64,7 +64,7 @@ class Statistics(object):
Attributes: Attributes:
errors (list of str): A list containing errors found while loading this errors (list): A list strings containing errors found while loading this
statistics information. statistics information.
data (dict): The original data for these statistics data (dict): The original data for these statistics
......
#!/usr/bin/env python #!/usr/bin/env python
# vim: set fileencoding=utf-8 : # -*- coding: utf-8 -*-
############################################################################### ###############################################################################
# # # #
...@@ -26,11 +26,8 @@ ...@@ -26,11 +26,8 @@
############################################################################### ###############################################################################
import os import os
import sys
import glob
import pkg_resources import pkg_resources
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
...@@ -54,7 +51,7 @@ extensions = [ ...@@ -54,7 +51,7 @@ extensions = [
] ]
# Be picky about warnings # Be picky about warnings
nitpicky = False nitpicky = True
# Ignores stuff we can't easily resolve on other project's sphinx manuals # Ignores stuff we can't easily resolve on other project's sphinx manuals
nitpick_ignore = [] nitpick_ignore = []
...@@ -82,7 +79,7 @@ autosummary_generate = True ...@@ -82,7 +79,7 @@ autosummary_generate = True
numfig = True numfig = True
# If we are on OSX, the 'dvipng' path maybe different # 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 if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
...@@ -253,23 +250,20 @@ autodoc_default_flags = [ ...@@ -253,23 +250,20 @@ autodoc_default_flags = [
'show-inheritance', '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: # 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.5.x/',
]
doc_server = '|'.join(doc_server)
from bob.extension.utils import link_documentation, load_requirements from bob.extension.utils import link_documentation, load_requirements
sphinx_requirements = "extra-intersphinx.txt" sphinx_requirements = "extra-intersphinx.txt"
if os.path.exists(sphinx_requirements): if os.path.exists(sphinx_requirements):
intersphinx_mapping = link_documentation( intersphinx_mapping = link_documentation(
additional_packages=['python','numpy'] + \ additional_packages=['python','numpy'] + \
load_requirements(sphinx_requirements), load_requirements(sphinx_requirements))
server=doc_server,
)
else: else:
intersphinx_mapping = link_documentation(server=doc_server) intersphinx_mapping = link_documentation()
# Adds simplejson, pyzmq links # Adds simplejson, pyzmq links
intersphinx_mapping['http://simplejson.readthedocs.io/en/stable/'] = None intersphinx_mapping['http://simplejson.readthedocs.io/en/stable/'] = None
...@@ -286,7 +280,8 @@ def member_function_test(app, what, name, obj, skip, options): ...@@ -286,7 +280,8 @@ def member_function_test(app, what, name, obj, skip, options):
if len(name) > 1 and name[0] == '_': if len(name) > 1 and name[0] == '_':
# test if this private function should be allowed # test if this private function should be allowed
if name not in accepted_private_functions: if name not in accepted_private_functions:
# omit privat functions that are not in the list of accepted private functions # omit private functions that are not in the list of accepted private
# functions
return skip return skip
else: else:
# test if the method is documented # test if the method is documented
......
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