Add .readthedocs.yml. Fixes #1406

.gitignore

@@ -39,8 +39,8 @@ MANIFEST
 htmlcov/
 .coverage
 
-doc/_build
-doc/__pycache__
+docs/_build
+docs/__pycache__
 
 # Artifacts of configuring in place
 deps/c-ares/config.log

.readthedocs.yml

+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Some things can only be configured on the RTD dashboard.
+# Those that we may have changed from the default include:
+
+# Analytics code:
+# Show Version Warning: False
+# Single Version: True
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+
+# Set the version of Python and requirements required to build your
+# docs
+python:
+  version: 3
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

MANIFEST.in

 recursive-include src/greentest *
 recursive-include examples *
 recursive-include src/gevent *
-recursive-include doc *
+recursive-include docs *
 recursive-include deps *
 recursive-include util *
 
@@ -20,6 +20,8 @@ include *.txt
 include _setup*.py
 include CHANGES.rst
 include pyproject.toml
+include .coveragerc
+include .coveragerc-pypy
 
 include tox.ini
 include .pep8
@@ -43,7 +45,7 @@ global-exclude *.o
 global-exclude *.lo
 global-exclude *.la
 global-exclude config.log config.status
-prune doc/_build
+prune docs/_build
 global-exclude *.pyc
 recursive-exclude src/greentest .coverage
 prune src/greentest/htmlcov
@@ -54,17 +56,17 @@ recursive-exclude deps/libev Makefile libtool stamp-h? config.h
 # This is the output of _corecffi_build.py and may be particular
 # to each CFFI version/platform
 recursive-exclude src/gevent _corecffi.c
-# See comments in Makefile; this is renamed to Makefile.ext
-# this exclude keeps check-manifest from complaining
-exclude Makefile
 exclude configure-output
 exclude configure-output.txt
 exclude deps/TAGS
+
 exclude deps/c-ares/ares_build.h
 exclude deps/c-ares/ares_config.h
 exclude deps/c-ares/libcares.pc
 exclude deps/c-ares/libtool
-include Makefile.ext
+exclude deps/c-ares/Makefile
+
+
 recursive-exclude deps/c-ares .deps .libs
 recursive-exclude deps/libuv .deps .libs
 recursive-exclude deps/libev .deps .libs

README.rst

@@ -11,7 +11,7 @@
 .. image:: https://coveralls.io/repos/gevent/gevent/badge.svg?branch=master&service=github
    :target: https://coveralls.io/github/gevent/gevent?branch=master
 
-.. include:: doc/_about.rst
+.. include:: docs/_about.rst
 
 Read the documentation online at http://www.gevent.org.
 
@@ -19,7 +19,7 @@ Post feedback and issues on the `bug tracker`_, `mailing list`_, blog_
 and `twitter (@gevent)`_.
 
 
-.. include:: doc/install.rst
+.. include:: docs/install.rst
 
 .. _bug tracker: https://github.com/gevent/gevent/wiki/Projects
 .. _mailing list: http://groups.google.com/group/gevent

_setuputils.py

@@ -283,7 +283,7 @@ class GeventClean(clean):
                 # Built wheels from manylinux
                 'wheelhouse',
                 # Doc build
-                os.path.join('.', 'doc', '_build'),
+                os.path.join('.', 'docs', '_build'),
             ]
         dir_finders = [
             # All python cache dirs

dev-requirements.txt

@@ -15,4 +15,4 @@ cffi >= 1.12.2 ; platform_python_implementation == 'CPython'
 # benchmarks use this
 perf >= 1.6.0
 
--e .[test,events,dnspython,doc]
+-e .[test,events,dnspython,docs]