fix rtd (#38)

* fix rtd

* minor fixes for rtd

* not using codecov for now

.github/workflows/main.yml

@@ -29,11 +29,11 @@ jobs:
       - name: Running tox
         run: |
           tox -e ${{ matrix.toxenv }}
-      - uses: codecov/codecov-action@v3
-        with:
-          fail_ci_if_error: true
-          files: coverage.xml
-          name: codecov
+      # - uses: codecov/codecov-action@v3
+      #   with:
+      #     fail_ci_if_error: true
+      #     files: coverage.xml
+      #     name: codecov
 
   codestyle:
     runs-on: ubuntu-latest

.gitignore

@@ -65,3 +65,4 @@ pip-wheel-metadata/
 .vscode
 
 *.log
+*.db

.readthedocs.yaml

@@ -9,21 +9,16 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
-    # You can also specify other tool versions:
-    # nodejs: "19"
-    # rust: "1.64"
-    # golang: "1.19"
+    python: "3.11"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/conf.py
-
-formats:
-   - pdf
+  configuration: docs/conf.py
 
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
     - requirements: requirements.txt
-    - method: setuptools
+    - method: pip
       path: .

docs/conf.py

@@ -48,6 +48,7 @@
     "sphinx.ext.viewcode",
 ]
 
+
 numpydoc_show_class_members = False
 
 # Add any paths that contain templates here, relative to this directory.
@@ -56,7 +57,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ["changes"]
 
 
 # -- Options for HTML output -------------------------------------------------

requirements.txt

@@ -0,0 +1,7 @@
+sphinx>=4.0.2
+sphinx_rtd_theme>=0.5.2
+readthedocs-sphinx-search>=0.1.0
+sphinx-automodapi>=0.13
+sphinx-changelog>=1.1.1
+towncrier>=21.3.0
+docutils>=0.16

setup.cfg

@@ -42,9 +42,13 @@ exclude =
 
 [options.extras_require]
 docs =
-  sphinx
-  sphinx-automodapi
-  sphinx-changelog>=1.1.0rc1  # First to support towncrier 21.3
+    sphinx>=4.0.2
+    sphinx_rtd_theme>=0.5.2
+    readthedocs-sphinx-search>=0.1.0
+    sphinx-automodapi>=0.13
+    sphinx-changelog>=1.1.1
+    towncrier>=21.3.0
+    docutils>=0.16
 
 [flake8]
 max-line-length = 110