Skip to content

Commit 9ccad0e

Browse files
authored
docs: add initial documentation to README.md (#39)
1 parent 0b924ac commit 9ccad0e

File tree

11 files changed

+497
-403
lines changed

11 files changed

+497
-403
lines changed

.readthedocs.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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
17+
formats:
18+
- pdf
19+
20+
# Optionally set the version of Python and requirements required to build your docs
21+
python:
22+
version: 3.7
23+
install:
24+
- requirements: docs/requirements.txt

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
include COPYING COPYING.LESSER README.md CHANGELOG.md
22
include tox.ini
3-
recursive-include docs *.py *.rst user/*rst Makefile make.bat
3+
recursive-include docs *.py *.rst Makefile make.bat requirements.txt
44
recursive-include tests/fixtures *.json

0 commit comments

Comments
 (0)