Skip to content

Commit a4a6871

Browse files
authored
Updated documentation (#87)
* Add readthedocs config
1 parent 9a5e5e2 commit a4a6871

File tree

3 files changed

+34
-9
lines changed

3 files changed

+34
-9
lines changed

.readthedocs.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Build documentation in the docs/ directory with Sphinx
9+
#sphinx:
10+
# configuration: docs/conf.py
11+
12+
# Build documentation with MkDocs
13+
mkdocs:
14+
configuration: mkdocs.yml
15+
16+
# Optionally build your docs in additional formats such as PDF and ePub
17+
formats: all
18+
19+
# Optionally set the version of Python and requirements required to build your docs
20+
python:
21+
version: 3.7
22+
install:
23+
- requirements: docs/requirements.txt

Pipfile.lock

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
mkdocs==1.0.4
2+
mkdocs-material==4.6.3

0 commit comments

Comments
 (0)