Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Travis-CI: Treat Sphinx warnings as errors #161

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Travis-CI: Treat Sphinx warnings as errors #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d778f5
DOC: Fix a few Sphinx warnings
mgeier Dec 16, 2019
1561238
DOC: Add generated API doc files to .gitignore
mgeier Dec 16, 2019
ea719f6
Travis-CI: Treat Sphinx warnings a errors
mgeier Dec 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ build/
dist/
.eggs/
sfs.egg-info/
doc/sfs.*.rst
2 changes: 1 addition & 1 deletion .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Sphinx>=1.3.6
Sphinx>=1.8
Sphinx-RTD-Theme
nbsphinx
ipykernel
Expand Down