Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
beat.core
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
14
Issues
14
List
Boards
Labels
Milestones
Merge Requests
3
Merge Requests
3
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
beat
beat.core
Commits
9b3097b7
Commit
9b3097b7
authored
Feb 20, 2019
by
André Anjos
💬
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[doc] Re-enable nitpicky mode; Fix broken docs
parent
fd77c14a
Pipeline
#27311
failed with stage
in 19 minutes and 40 seconds
Changes
8
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
8 changed files
with
29 additions
and
34 deletions
+29
-34
beat/core/dataformat.py
beat/core/dataformat.py
+2
-2
beat/core/execution/base.py
beat/core/execution/base.py
+4
-4
beat/core/execution/remote.py
beat/core/execution/remote.py
+4
-4
beat/core/execution/subprocess.py
beat/core/execution/subprocess.py
+4
-4
beat/core/experiment.py
beat/core/experiment.py
+1
-1
beat/core/plotter.py
beat/core/plotter.py
+1
-1
beat/core/stats.py
beat/core/stats.py
+1
-1
doc/conf.py
doc/conf.py
+12
-17
No files found.
beat/core/dataformat.py
View file @
9b3097b7
...
...
@@ -92,8 +92,8 @@ class DataFormat(BackendDataFormat):
storage (object): A simple object that provides information about file
paths for this dataformat
errors (list
of str): A list containing errors found while loading this
dataformat.
errors (list
): A list of strings containing errors found while loading
this
dataformat.
data (dict): The original data for this dataformat, as loaded by our JSON
decoder.
...
...
beat/core/execution/base.py
View file @
9b3097b7
...
...
@@ -123,11 +123,11 @@ class BaseExecutor(object):
for that particular combination of details. The dictionary may be empty
in case all inputs are taken from the file cache.
input_list (beat.
core.inputs.InputList): A list of inputs that will be
served to the algorithm.
input_list (beat.
backend.python.inputs.InputList): A list of inputs that
will be
served to the algorithm.
output_list (beat.
core.outputs.OutputList): A list of outputs that the
algorithm will produce.
output_list (beat.
backend.python.outputs.OutputList): A list of outputs
that the
algorithm will produce.
data_sources (list): A list with all data-sources created by our execution
loader.
...
...
beat/core/execution/remote.py
View file @
9b3097b7
...
...
@@ -115,11 +115,11 @@ class RemoteExecutor(BaseExecutor):
for that particular combination of details. The dictionary may be empty
in case all inputs are taken from the file cache.
input_list (beat.
core.inputs.InputList): A list of inputs that will be
served to the algorithm.
input_list (beat.
backend.python.inputs.InputList): A list of inputs that
will be
served to the algorithm.
output_list (beat.
core.outputs.OutputList): A list of outputs that the
algorithm will produce.
output_list (beat.
backend.python.outputs.OutputList): A list of outputs
that the
algorithm will produce.
data_sources (list): A list with all data-sources created by our execution
loader.
...
...
beat/core/execution/subprocess.py
View file @
9b3097b7
...
...
@@ -141,11 +141,11 @@ class SubprocessExecutor(RemoteExecutor):
for that particular combination of details. The dictionary may be empty
in case all inputs are taken from the file cache.
input_list (beat.
core.inputs.InputList): A list of inputs that will be
served to the algorithm.
input_list (beat.
backend.python.inputs.InputList): A list of inputs that
will be
served to the algorithm.
output_list (beat.
core.outputs.OutputList): A list of outputs that the
algorithm will produce.
output_list (beat.
backend.python.outputs.OutputList): A list of outputs
that the
algorithm will produce.
data_sources (list): A list with all data-sources created by our execution
loader.
...
...
beat/core/experiment.py
View file @
9b3097b7
...
...
@@ -164,7 +164,7 @@ class Experiment(object):
:py:class:`beat.core.algorithm.Algorithm` pointers for all analyzers in
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.
data (dict): The original data for this experiment, as loaded by our JSON
...
...
beat/core/plotter.py
View file @
9b3097b7
...
...
@@ -148,7 +148,7 @@ class Plotter(object):
storage (object): A simple object that provides information about file
paths for this algorithm
dataformat (obj): An object of type :py:class:`.dataformat.DataFormat`
dataformat (obj
ect
): An object of type :py:class:`.dataformat.DataFormat`
that represents the dataformat to which this plotter is applicable.
libraries (dict): A mapping object defining other libraries this plotter
...
...
beat/core/stats.py
View file @
9b3097b7
...
...
@@ -64,7 +64,7 @@ class Statistics(object):
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.
data (dict): The original data for these statistics
...
...
doc/conf.py
View file @
9b3097b7
#!/usr/bin/env python
#
vim: set fileencoding=utf-8 :
#
-*- coding: utf-8 -*-
###############################################################################
# #
...
...
@@ -26,11 +26,8 @@
###############################################################################
import
os
import
sys
import
glob
import
pkg_resources
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
...
...
@@ -54,7 +51,7 @@ extensions = [
]
# Be picky about warnings
nitpicky
=
False
nitpicky
=
True
# Ignores stuff we can't easily resolve on other project's sphinx manuals
nitpick_ignore
=
[]
...
...
@@ -82,7 +79,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.
...
...
@@ -253,23 +250,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.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
()
# Adds simplejson, pyzmq links
intersphinx_mapping
[
'http://simplejson.readthedocs.io/en/stable/'
]
=
None
...
...
@@ -286,7 +280,8 @@ def member_function_test(app, what, name, obj, skip, options):
if
len
(
name
)
>
1
and
name
[
0
]
==
'_'
:
# test if this private function should be allowed
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
else
:
# test if the method is documented
...
...
Write
Preview
Markdown
is supported
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