Skip to content

Commit

Permalink
Add support for ReadTheDocs (#1328)
Browse files Browse the repository at this point in the history
* Add .readthedocs.yml
  • Loading branch information
tburrows13 authored Oct 4, 2020
1 parent d367014 commit fd71ed1
Show file tree
Hide file tree
Showing 2 changed files with 24 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: docs/conf.py

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

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- method: pip
path: .
extra_requirements:
- doc
4 changes: 1 addition & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,7 @@ def run_tests(self):

doc_reqs = [
"pygame>=1.9.3,<2.0; python_version<'3.8'",
"numpydoc>=0.6.0,<1.0",
"sphinx_rtd_theme>=0.1.10b0,<1.0",
"Sphinx>=1.5.2,<2.0",
"numpydoc<2.0",
]

test_reqs = [
Expand Down

0 comments on commit fd71ed1

Please sign in to comment.