debug

.github/workflows/doc.yml

@@ -25,6 +25,8 @@ jobs:
 
       - name: Build docs
         run: |
+          sphinx-build --version
+          python --version
           cd doc
           make html
 

doc/source/conf.py

@@ -33,6 +33,11 @@
     "torch",
 ]
 
+suppress_warnings = [
+    "ref.citation",
+    "parallel.write",
+]
+
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 

doc/source/overview/index.rst

@@ -6,3 +6,24 @@ What's in the box?
 
 Installation
 ------------
+
+Supported Python versions: 3.10+
+
+*From PyPI*
+
+.. code-block:: bash
+    :linenos:
+
+    pip install hopes
+
+*From source (development version)*
+
+.. code-block:: bash
+    :linenos:
+
+    git clone https://github.com/airboxlab/hopes.git
+    cd hopes
+    # using poetry
+    poetry install
+    # using pip
+    pip install -r requirements.txt