docs

mir-group · May 28, 2021 · 7a5172a · 7a5172a
1 parent 18257ab
commit 7a5172a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -13,6 +13,5 @@ sphinx:
 python:
    version: 3.7
    install:
-    - requirements: docs/requirements.txt
     - method: pip
       path: .
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,6 +29,8 @@
 # ones.
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_rtd_theme"]
 
+autodoc_mock_imports = ["torch", "torch_scatter"]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,12 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+================
 pytorch_runstats
 ================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+ .. toctree::
+
+   self
 
 
 ``torch_runstats`` implements memory-efficient online reductions on tensors. Notable features: