Skip to content

Commit

Permalink
Add Read the Docs configuration file
Browse files Browse the repository at this point in the history
  • Loading branch information
laurent-laporte-pro committed Nov 14, 2021
1 parent cb49dd1 commit d4ccbf6
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .editorconfig
Expand Up @@ -12,5 +12,8 @@ charset = utf-8
[*.{xml,xsl,xsd,xd}]
indent_size = 2

[*.{yml,yaml}]
indent_size = 2

[*.{bat,cmd,ps1}]
end_of_line = crlf
25 changes: 25 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,25 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

formats:
- epub
- pdf

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.8"

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

python:
install:
- requirements: docs/requirements.txt
14 changes: 13 additions & 1 deletion docs/requirements.txt
@@ -1,2 +1,14 @@
sphinx
# By default, ReadTheDocs installs the following old versions:
# https://github.com/readthedocs/readthedocs.org/issues/7858
#
# mock==1.0.1
# pillow==5.4.1
# alabaster>=0.7,<0.8,!=0.7.5
# commonmark==0.8.1
# recommonmark==0.5.0
# sphinx<2
# sphinx-rtd-theme<0.5
# readthedocs-sphinx-ext<2.2

Sphinx~=4.3.0
-e .

0 comments on commit d4ccbf6

Please sign in to comment.