Skip to content

Commit

Permalink
docs: ZENKO-2639 add .readthedocs.yml file spec
Browse files Browse the repository at this point in the history
As recommended by readthedocs, we're adding the proper
yaml spec file to specify the configurations to build the
documentation.

It also provides build time env variable that will help us
identify in the build if we are building with readthedocs or not.
  • Loading branch information
tcarmet committed Jun 4, 2020
1 parent a5b50a5 commit dac0f97
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# .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:
configuration: docs/docsource/conf.py

# Optionally build your docs in additional formats such as PDF
formats: []

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: docs/docsource/requirements.txt

0 comments on commit dac0f97

Please sign in to comment.