docs: Update docs for 2020

- Update version in What's New. - Remove mention of google groups mailing list. - Use autoapi (instead of autodoc) for compatibility with readthedocs
GMDDTK · Aug 17, 2020 · a0fcfb0 · a0fcfb0
1 parent 251c01d
commit a0fcfb0
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 31 deletions.
diff --git a/doc/source/api.rst b/doc/source/api.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -9,10 +9,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'sphinx.ext.autodoc',
     'sphinx_rtd_theme',
     'numpydoc',
+    'autoapi.extension',
 ]
+autoapi_dirs = [os.path.join("..", "..", "lda")]
+autoapi_ignore = ["*tests*"]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.

diff --git a/doc/source/groups.rst b/doc/source/groups.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -68,9 +68,8 @@ Contents:
 
    getting_started
    installation
-   api
+   autoapi/index
    contributing
-   groups
    whats_new
 
 Indices and tables

diff --git a/doc/source/whats_new.rst b/doc/source/whats_new.rst
@@ -6,6 +6,11 @@
  What's New
 ============
 
+v2.0.0 (17. August 2020)
+==========================
+- Drop support for Python 2.7
+- Wheels for Python 3.8
+
 v1.1.0 (9. September 2018)
 ==========================
 - Wheels for Python 3.7

diff --git a/test-requirements.txt b/test-requirements.txt
@@ -11,6 +11,7 @@ coverage>=3.6
 discover
 python-subunit
 sphinx>=1.1.2
+sphinx-autoapi~=1.4.0
 oslosphinx
 oslotest>=1.1.0.0a2
 testrepository>=0.0.18