diff options
| author | Philip Paquette <pcpaquette@gmail.com> | 2019-09-11 12:58:45 -0400 |
|---|---|---|
| committer | Philip Paquette <pcpaquette@gmail.com> | 2019-09-14 18:18:53 -0400 |
| commit | abb42dcd4886705d6ba8af27f68ef605218ac67c (patch) | |
| tree | 9ae16f7a09fff539fa72e65198e284bca6ac3376 /.readthedocs.yml | |
| parent | a954a00d263750c279dbb2c0a9ae85707022bcd7 (diff) | |
Added ReadtheDocs documentation for the public API
- Reformatted the docstring to be compatible
- Added tests to make sure the documentation compiles properly
- Added sphinx as a pip requirement
Co-authored-by: Philip Paquette <pcpaquette@gmail.com>
Co-authored-by: notoraptor <stevenbocco@gmail.com>
Diffstat (limited to '.readthedocs.yml')
| -rw-r--r-- | .readthedocs.yml | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..22d6d3c --- /dev/null +++ b/.readthedocs.yml @@ -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/conf.py + +# 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: requirements_dev.txt |