Skip to content

Commit

Permalink
update rtd build file
Browse files Browse the repository at this point in the history
  • Loading branch information
sosey committed Jul 17, 2019
1 parent f8c3dfa commit bcd7fc6
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/conf.py
fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

build:
image: latest

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: docs/rtd-pip-requirements
- method: pip
path: .
extra_requirements:
- docs
- method: setuptools
path: .
system_packages: false

submodules:
include: all
4 changes: 4 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ def _warn_node(self, msg, node, **kwargs):
os.path.abspath(os.path.join(os.path.dirname(__file__),
'local/python2_local_links.inv')))


# suppress epub errors for static file formats (.ico) on rtd
suppress_warnings = ['epub.unknown_project_files']

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
Expand Down

0 comments on commit bcd7fc6

Please sign in to comment.