Skip to content

Commit

Permalink
add requirements.txt file for docs creation, add readthedocs.yml file…
Browse files Browse the repository at this point in the history
… too
  • Loading branch information
Daniel Holbach committed Jul 29, 2019
1 parent 554da47 commit b0ddc24
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 3 deletions.
23 changes: 23 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# .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: site/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

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

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: site/requirements.txt
6 changes: 3 additions & 3 deletions site/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
FROM ddidier/sphinx-doc

COPY requirements.txt .

RUN apt update && apt install -y linkchecker && \
pip install 'sphinx == 2.1.2' \
'sphinx_markdown_tables == 0.0.9' \
'recommonmark == 0.5.0'
pip install -r requirements.txt

WORKDIR /doc

Expand Down
3 changes: 3 additions & 0 deletions site/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinx == 2.1.2
sphinx_markdown_tables == 0.0.9
recommonmark == 0.5.0

0 comments on commit b0ddc24

Please sign in to comment.