Fix readthedocs build (#133)

* update documentation build

.github/workflows/python-package.yml

@@ -24,6 +24,7 @@ jobs:
         python -m pip install --upgrade pip
         python -m pip install flake8 pytest pytest-cov
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        python -m pip install -e .
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt

requirements.txt → docs/requirements.txt

@@ -1,2 +1,4 @@
+sphinx>=3.0
+sphinx-rtd-theme
 requests>=2.0.0,<3.0.0
 beautifulsoup4

docs/source/_static/custom.css

@@ -0,0 +1,4 @@
+/* Set the properties to be full width */
+dl.py.property {
+    display: block !important;
+}