From df7a84f6b9174b44c01227893fc00eb0fa4419a5 Mon Sep 17 00:00:00 2001 From: Zohreh MOSTAANI Date: Fri, 28 Jun 2019 13:43:44 +0200 Subject: [PATCH 1/6] fixed latex_documents not having correct author --- doc/conf.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 57d47a45..6c360f5b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -252,9 +252,17 @@ latex_elements = { # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - (master_doc, top_module + '.tex', project, authors, 'manual'), -] +# latex_documents = [ +# (master_doc, top_module + '.tex', project, authors, 'manual'), +# ] + +latex_documents = [( + 'index', + project_variable + '.tex', + short_description, + owner[0], + 'manual', + )] # The name of an image file (relative to this directory) to place at the top of # the title page. -- GitLab From 9d25650b55ba1dcf084386cf2cd47148284ad165 Mon Sep 17 00:00:00 2001 From: Zohreh MOSTAANI Date: Mon, 1 Jul 2019 11:48:43 +0200 Subject: [PATCH 2/6] editted conf.py to supress warnings for unused rst files --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 6c360f5b..9008998a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -123,7 +123,7 @@ release = distribution.version # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = [] +exclude_patterns = ['**/**/script*.rst', 'links.rst'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None -- GitLab From 6b54c1b1ab50eb1bacf339242b8d75fc36957139 Mon Sep 17 00:00:00 2001 From: Zohreh MOSTAANI Date: Tue, 2 Jul 2019 11:51:18 +0200 Subject: [PATCH 3/6] small modifications to fix some other warnings --- doc/admin/conf.py | 1 + doc/api/conf.py | 29 +++++++++++++++-------------- doc/api/index.rst | 1 - doc/conf.py | 29 +++++++++++++++++++---------- doc/user/conf.py | 2 ++ doc/user/settings/guide.rst | 2 ++ 6 files changed, 39 insertions(+), 25 deletions(-) diff --git a/doc/admin/conf.py b/doc/admin/conf.py index ebc1f0e1..d51c0807 100644 --- a/doc/admin/conf.py +++ b/doc/admin/conf.py @@ -48,6 +48,7 @@ extensions = [ 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'sphinxcontrib.programoutput', + 'sphinxcontrib.httpdomain', ] # Always includes todos diff --git a/doc/api/conf.py b/doc/api/conf.py index 20262ad4..f27ad72c 100644 --- a/doc/api/conf.py +++ b/doc/api/conf.py @@ -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() diff --git a/doc/api/index.rst b/doc/api/index.rst index b6fbda88..01a901a1 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -31,7 +31,6 @@ introduction web_api - api/beat.web Indices and tables ================== diff --git a/doc/conf.py b/doc/conf.py index 9008998a..f0b8bf54 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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,) diff --git a/doc/user/conf.py b/doc/user/conf.py index a34c6df2..acac5b1d 100644 --- a/doc/user/conf.py +++ b/doc/user/conf.py @@ -52,6 +52,8 @@ extensions = [ 'sphinx.ext.graphviz', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', + 'sphinxcontrib.programoutput', + 'sphinxcontrib.httpdomain', ] # Always includes todos diff --git a/doc/user/settings/guide.rst b/doc/user/settings/guide.rst index 09ec0a40..11c058ad 100644 --- a/doc/user/settings/guide.rst +++ b/doc/user/settings/guide.rst @@ -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 -- GitLab From e8b832b460e82cd5cd2c2affdff58db72d5fb032 Mon Sep 17 00:00:00 2001 From: Zohreh MOSTAANI Date: Fri, 18 Oct 2019 11:36:10 +0200 Subject: [PATCH 4/6] [docedit] removed Biometrics evaluation and testing from definition of BEAT --- AUTHORS.rst | 6 +++--- .../templates/navigation/legal_disclaimer.rst | 2 +- .../templates/navigation/terms_of_service.rst | 4 ++-- doc/admin/index.rst | 13 ++++++------- doc/api/conf.py | 2 +- doc/conf.py | 2 +- setup.py | 2 +- 7 files changed, 15 insertions(+), 16 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 09205bc2..cce4283a 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -20,9 +20,9 @@ .. You should have received a copy of the GNU Affero Public License along .. .. with the BEAT platform. If not, see http://www.gnu.org/licenses/. .. -=========================================================== - Authors of the Biometrics Evaluation and Testing Platform -=========================================================== +============================== + Authors of the BEAT Platform +============================== Andre Anjos Flavio Tarsetti diff --git a/beat/web/navigation/templates/navigation/legal_disclaimer.rst b/beat/web/navigation/templates/navigation/legal_disclaimer.rst index 3fbf9e9b..b84c7de3 100644 --- a/beat/web/navigation/templates/navigation/legal_disclaimer.rst +++ b/beat/web/navigation/templates/navigation/legal_disclaimer.rst @@ -37,7 +37,7 @@ Version 1.0 (effective as of March 1st, 2014) -The Biometrics Evaluation and Testing ("**BEAT**") project is a four-year +The "**BEAT**" project is a four-year European research project led by THE FOUNDATION OF IDIAP RESEARCH INSTITUTE ("**IDIAP**"), Centre du Parc, Rue Marconi 19, PO Box 592, CH - 1920 Martigny, Switzerland, which aims at developing a platform for the testing, evaluation diff --git a/beat/web/navigation/templates/navigation/terms_of_service.rst b/beat/web/navigation/templates/navigation/terms_of_service.rst index d9792a17..57bd7ff2 100644 --- a/beat/web/navigation/templates/navigation/terms_of_service.rst +++ b/beat/web/navigation/templates/navigation/terms_of_service.rst @@ -39,11 +39,11 @@ Version 1.0 (effective as of March 1st, 2014) -The Biometrics Evaluation and Testing ("**BEAT**") project is a four-year +The "**BEAT**" project is a four-year European research project led by THE FOUNDATION OF IDIAP RESEARCH INSTITUTE ("**IDIAP**"), Centre du Parc, Rue Marconi 19, PO Box 592, CH - 1920 Martigny, Switzerland, which aims at developing a platform for the testing, evaluation -and attestation of biometric systems, in particular by the sharing of open +and attestation of machine learning systems, in particular by the sharing of open source implementations of algorithms. ============= diff --git a/doc/admin/index.rst b/doc/admin/index.rst index 27baa3e7..651620fd 100644 --- a/doc/admin/index.rst +++ b/doc/admin/index.rst @@ -23,16 +23,15 @@ .. _beat_web_admin: -========================= -BEAT Administrator Guide -========================= +========================== + BEAT Administrator Guide +========================== -BEAT stands for "Biometrics Evaluation And Testing". It is a EC-FP7 sponsored -project to build a web-based, biometry-independent platform for Biometrics +BEAT is a EC-FP7 sponsored +project to build a web-based platform for machine learning research and certification. By making use of such a system, academic or industrial parties enable users to easily compare results from distinct -algorithms or/and parameterizations with minimal interaction using one or -potentially many biometric traits. +algorithms or/and parameterizations with minimal interaction. This document contains resources for system administrators regarding the conception, dimensioning, hardware implementation and installation of a diff --git a/doc/api/conf.py b/doc/api/conf.py index 0cd45a9e..19920e65 100644 --- a/doc/api/conf.py +++ b/doc/api/conf.py @@ -146,7 +146,7 @@ pygments_style = 'sphinx' # Some variables which are useful for generated material project_variable = project.replace('.', '_').replace(' ', '_') -short_description = u'Biometrics Evaluation and Testing Platform (Web Modules)' +short_description = u'BEAT Platform (Web Modules)' owner = [u'Idiap Research Institute'] diff --git a/doc/conf.py b/doc/conf.py index 27b3137d..850d53c3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -150,7 +150,7 @@ pygments_style = 'sphinx' # Some variables which are useful for generated material project_variable = project.replace('.', '_') -short_description = u'Biometrics Evaluation and Testing Platform (Web Modules)' +short_description = u'BEAT Platform (Web Modules)' owner = [u'Idiap Research Institute'] diff --git a/setup.py b/setup.py index d5aa4e4b..b57afb99 100644 --- a/setup.py +++ b/setup.py @@ -38,7 +38,7 @@ def load_requirements(f): setup( name="beat.web", version=open("version.txt").read().rstrip(), - description="Biometrics Evaluation and Testing Platform (Web Modules)", + description="BEAT Platform (Web Modules)", url="https://gitlab.idiap.ch/beat/beat.web", license="AGPLv3", author="Idiap Research Institute", -- GitLab From 41a52d540a93d95e22cbdb364d40a6394b75c5f2 Mon Sep 17 00:00:00 2001 From: Zohreh MOSTAANI Date: Mon, 21 Oct 2019 13:55:09 +0200 Subject: [PATCH 5/6] [docedit] more modification regarding discussions --- beat/web/navigation/templates/navigation/legal_disclaimer.rst | 3 +-- beat/web/navigation/templates/navigation/terms_of_service.rst | 3 +-- doc/admin/index.rst | 3 +-- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/beat/web/navigation/templates/navigation/legal_disclaimer.rst b/beat/web/navigation/templates/navigation/legal_disclaimer.rst index b84c7de3..eb9d85f7 100644 --- a/beat/web/navigation/templates/navigation/legal_disclaimer.rst +++ b/beat/web/navigation/templates/navigation/legal_disclaimer.rst @@ -37,8 +37,7 @@ Version 1.0 (effective as of March 1st, 2014) -The "**BEAT**" project is a four-year -European research project led by THE FOUNDATION OF IDIAP RESEARCH INSTITUTE +The "**BEAT**" framework is a project led by THE FOUNDATION OF IDIAP RESEARCH INSTITUTE ("**IDIAP**"), Centre du Parc, Rue Marconi 19, PO Box 592, CH - 1920 Martigny, Switzerland, which aims at developing a platform for the testing, evaluation and attestation of biometric systems, in particular by the sharing of open diff --git a/beat/web/navigation/templates/navigation/terms_of_service.rst b/beat/web/navigation/templates/navigation/terms_of_service.rst index 57bd7ff2..0b36596e 100644 --- a/beat/web/navigation/templates/navigation/terms_of_service.rst +++ b/beat/web/navigation/templates/navigation/terms_of_service.rst @@ -39,8 +39,7 @@ Version 1.0 (effective as of March 1st, 2014) -The "**BEAT**" project is a four-year -European research project led by THE FOUNDATION OF IDIAP RESEARCH INSTITUTE +The "**BEAT**" framework is a project led by THE FOUNDATION OF IDIAP RESEARCH INSTITUTE ("**IDIAP**"), Centre du Parc, Rue Marconi 19, PO Box 592, CH - 1920 Martigny, Switzerland, which aims at developing a platform for the testing, evaluation and attestation of machine learning systems, in particular by the sharing of open diff --git a/doc/admin/index.rst b/doc/admin/index.rst index 651620fd..eb4adbf6 100644 --- a/doc/admin/index.rst +++ b/doc/admin/index.rst @@ -27,8 +27,7 @@ BEAT Administrator Guide ========================== -BEAT is a EC-FP7 sponsored -project to build a web-based platform for machine learning +BEAT framework is a project to build a platform for machine learning research and certification. By making use of such a system, academic or industrial parties enable users to easily compare results from distinct algorithms or/and parameterizations with minimal interaction. -- GitLab From 8cc4d78cfc41e0015c33d228d99ead3f051f3ef3 Mon Sep 17 00:00:00 2001 From: Zohreh MOSTAANI Date: Wed, 30 Oct 2019 17:35:32 +0100 Subject: [PATCH 6/6] [docedit] minor modifications --- beat/web/navigation/templates/navigation/legal_disclaimer.rst | 3 +-- beat/web/navigation/templates/navigation/terms_of_service.rst | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/beat/web/navigation/templates/navigation/legal_disclaimer.rst b/beat/web/navigation/templates/navigation/legal_disclaimer.rst index eb9d85f7..f1b6de2c 100644 --- a/beat/web/navigation/templates/navigation/legal_disclaimer.rst +++ b/beat/web/navigation/templates/navigation/legal_disclaimer.rst @@ -37,8 +37,7 @@ Version 1.0 (effective as of March 1st, 2014) -The "**BEAT**" framework is a project led by THE FOUNDATION OF IDIAP RESEARCH INSTITUTE -("**IDIAP**"), Centre du Parc, Rue Marconi 19, PO Box 592, CH - 1920 Martigny, +The "**BEAT**" framework is a project led by Idiap Research Institute, Centre du Parc, Rue Marconi 19, PO Box 592, CH - 1920 Martigny, Switzerland, which aims at developing a platform for the testing, evaluation and attestation of biometric systems, in particular by the sharing of open source implementations of algorithms. diff --git a/beat/web/navigation/templates/navigation/terms_of_service.rst b/beat/web/navigation/templates/navigation/terms_of_service.rst index 0b36596e..6211d349 100644 --- a/beat/web/navigation/templates/navigation/terms_of_service.rst +++ b/beat/web/navigation/templates/navigation/terms_of_service.rst @@ -39,8 +39,7 @@ Version 1.0 (effective as of March 1st, 2014) -The "**BEAT**" framework is a project led by THE FOUNDATION OF IDIAP RESEARCH INSTITUTE -("**IDIAP**"), Centre du Parc, Rue Marconi 19, PO Box 592, CH - 1920 Martigny, +The "**BEAT**" framework is a project led by Idiap Research Institute, Centre du Parc, Rue Marconi 19, PO Box 592, CH - 1920 Martigny, Switzerland, which aims at developing a platform for the testing, evaluation and attestation of machine learning systems, in particular by the sharing of open source implementations of algorithms. -- GitLab