From 4ba1535f422c2cd54708a1416817902f67b7ba32 Mon Sep 17 00:00:00 2001
From: Amir Mohammadi <183.amir@gmail.com>
Date: Wed, 5 Oct 2016 10:29:06 +0200
Subject: [PATCH 1/5] [Automatic] update links and the ci mostly
---
develop.cfg | 4 ++--
doc/conf.py | 34 ++++++++++++++++++++++++++++++----
2 files changed, 32 insertions(+), 6 deletions(-)
diff --git a/develop.cfg b/develop.cfg
index 6cde232..c5446ea 100644
--- a/develop.cfg
+++ b/develop.cfg
@@ -18,8 +18,8 @@ verbose = true
newest = false
[sources]
-bob.extension = git git@gitlab.idiap.ch:bob/bob.extension
-bob.blitz = git git@gitlab.idiap.ch:bob/bob.blitz
+bob.extension = git https://gitlab.idiap.ch/bob/bob.extension
+bob.blitz = git https://gitlab.idiap.ch/bob/bob.blitz
[scripts]
recipe = bob.buildout:scripts
diff --git a/doc/conf.py b/doc/conf.py
index 32991d3..daf4fd1 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -30,9 +30,29 @@ extensions = [
import sphinx
if sphinx.__version__ >= "1.4.1":
extensions.append('sphinx.ext.imgmath')
+ imgmath_image_format = 'svg'
else:
extensions.append('sphinx.ext.pngmath')
+# Be picky about warnings
+nitpicky = True
+
+# Ignores stuff we can't easily resolve on other project's sphinx manuals
+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))
+
# Always includes todos
todo_include_todos = True
@@ -59,7 +79,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'bob.core'
+project = u'<PROJECT>'
import time
copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')
@@ -111,7 +131,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
-short_description = u'Core utilities required on all Bob modules'
+short_description = u'<SHORT_DESCRIPTION>'
owner = [u'Idiap Research Institute']
@@ -195,6 +215,7 @@ html_favicon = 'img/favicon.ico'
# Output file base name for HTML help builder.
htmlhelp_basename = project_variable + u'_doc'
+
# -- Post configuration --------------------------------------------------------
# Included after all input documents
@@ -215,8 +236,13 @@ autodoc_default_flags = [
]
# For inter-documentation mapping:
-from bob.extension.utils import link_documentation
-intersphinx_mapping = link_documentation()
+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=load_requirements(sphinx_requirements))
+else:
+ intersphinx_mapping = link_documentation()
+
# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
--
GitLab
From eaaaf56975a39d412c0c1a33e645ce01da89aa18 Mon Sep 17 00:00:00 2001
From: Amir Mohammadi <183.amir@gmail.com>
Date: Wed, 5 Oct 2016 10:57:13 +0200
Subject: [PATCH 2/5] [Automatic] update links and the ci mostly
---
doc/conf.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index daf4fd1..67ffa0d 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -79,7 +79,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'<PROJECT>'
+project = u'bob.core'
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'<SHORT_DESCRIPTION>'
+short_description = u''
owner = [u'Idiap Research Institute']
--
GitLab
From 270ccbb4a86668ac74910e7bf35e5e1e5277c6c1 Mon Sep 17 00:00:00 2001
From: Amir Mohammadi <183.amir@gmail.com>
Date: Wed, 5 Oct 2016 10:58:14 +0200
Subject: [PATCH 3/5] [Automatic] update links and the ci mostly
---
doc/conf.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/conf.py b/doc/conf.py
index 67ffa0d..8f00c16 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -131,7 +131,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
-short_description = u''
+short_description = u'Core utilities required on all Bob modules'
owner = [u'Idiap Research Institute']
--
GitLab
From 11e227190ec16b713512af15068d19acffa42754 Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.anjos@idiap.ch>
Date: Wed, 12 Oct 2016 12:50:57 +0200
Subject: [PATCH 4/5] Add exceptions to documentation
---
doc/nitpick-exceptions.txt | 10 ++++++++++
1 file changed, 10 insertions(+)
create mode 100644 doc/nitpick-exceptions.txt
diff --git a/doc/nitpick-exceptions.txt b/doc/nitpick-exceptions.txt
new file mode 100644
index 0000000..6593373
--- /dev/null
+++ b/doc/nitpick-exceptions.txt
@@ -0,0 +1,10 @@
+# no sphinx correlation for these
+c:type boost
+c:type shared_ptr
+c:type mt19937
+
+# this is actually a c type
+cpp:type PyObject
+cpp:type Py_ssize_t
+
+py:meth __call__
--
GitLab
From 2a7a1c28fa3a86d07dc25daef135961ccdc71cd9 Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.anjos@idiap.ch>
Date: Wed, 12 Oct 2016 12:55:10 +0200
Subject: [PATCH 5/5] Add exception for py27
---
doc/nitpick-exceptions.txt | 3 +++
1 file changed, 3 insertions(+)
diff --git a/doc/nitpick-exceptions.txt b/doc/nitpick-exceptions.txt
index 6593373..83223a1 100644
--- a/doc/nitpick-exceptions.txt
+++ b/doc/nitpick-exceptions.txt
@@ -7,4 +7,7 @@ c:type mt19937
cpp:type PyObject
cpp:type Py_ssize_t
+# exceptions are not found in python 2.7
+py:exc ValueError
+
py:meth __call__
--
GitLab