From 4d778f58f6b26d639d23401a45db9ec3e4a513cb Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Mon, 16 Dec 2019 17:37:26 +0100 Subject: [PATCH 1/3] DOC: Fix a few Sphinx warnings --- doc/conf.py | 4 ++-- doc/requirements.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 07b7c4f..6a403c8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -173,7 +173,7 @@ #keep_warnings = False jinja_define = """ -{% set docname = env.doc2path(env.docname, base='doc') %} +{% set docname = 'doc/' + env.doc2path(env.docname, base=None) %} {% set latex_href = ''.join([ '\href{https://github.com/sfstoolbox/sfs-python/blob/', env.config.release, @@ -219,7 +219,7 @@ def setup(app): """Include custom theme files to sphinx HTML header""" - app.add_stylesheet('css/title.css') + app.add_css_file('css/title.css') # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. diff --git a/doc/requirements.txt b/doc/requirements.txt index e2e3ce9..082810e 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,4 @@ -Sphinx>=1.3.6 +Sphinx>=1.8 Sphinx-RTD-Theme nbsphinx ipykernel From 15612385a259b31d2d67cbcf03923583edc10e0a Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Mon, 16 Dec 2019 17:56:59 +0100 Subject: [PATCH 2/3] DOC: Add generated API doc files to .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index e1b18df..a8e2922 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ build/ dist/ .eggs/ sfs.egg-info/ +doc/sfs.*.rst From ea719f604224559f15e8a92ed8d43d46f28b49cb Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Mon, 16 Dec 2019 17:57:37 +0100 Subject: [PATCH 3/3] Travis-CI: Treat Sphinx warnings a errors --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 11dc995..44dc3e1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -30,4 +30,4 @@ script: - python3 -m pytest - python3 doc/examples/run_all.py # This executes the example notebooks and runs the doctests: - - python3 -m sphinx doc/ _build/ -b doctest + - python3 -m sphinx doc/ _build/ -b doctest -W