build sphinx api docs

RMeli · Aug 1, 2022 · 2ca0213 · 2ca0213
1 parent 2d79a1b
commit 2ca0213
Show file tree

Hide file tree

Showing 19 changed files with 104 additions and 45 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,7 +5,7 @@
 SPHINXOPTS =
 SPHINXBUILD = sphinx-build
 SPHINXPROJ = gninatorch
-SOURCEDIR = .
+SOURCEDIR = source
 BUILDDIR = _build
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -0,0 +1,8 @@
+API Documentation
+=================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ api/gninatorch
diff --git a/docs/source/api/gninatorch.dataloaders.rst b/docs/source/api/gninatorch.dataloaders.rst
@@ -0,0 +1,7 @@
+gninatorch.dataloaders module
+=============================
+
+.. automodule:: gninatorch.dataloaders
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/gninatorch.gnina.rst b/docs/source/api/gninatorch.gnina.rst
@@ -0,0 +1,7 @@
+gninatorch.gnina module
+=======================
+
+.. automodule:: gninatorch.gnina
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/gninatorch.inference.rst b/docs/source/api/gninatorch.inference.rst
@@ -0,0 +1,7 @@
+gninatorch.inference module
+===========================
+
+.. automodule:: gninatorch.inference
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/gninatorch.losses.rst b/docs/source/api/gninatorch.losses.rst
@@ -0,0 +1,7 @@
+gninatorch.losses module
+========================
+
+.. automodule:: gninatorch.losses
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/gninatorch.metrics.rst b/docs/source/api/gninatorch.metrics.rst
@@ -0,0 +1,7 @@
+gninatorch.metrics module
+=========================
+
+.. automodule:: gninatorch.metrics
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/gninatorch.models.rst b/docs/source/api/gninatorch.models.rst
@@ -0,0 +1,7 @@
+gninatorch.models module
+========================
+
+.. automodule:: gninatorch.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/gninatorch.rst b/docs/source/api/gninatorch.rst
@@ -0,0 +1,24 @@
+gninatorch package
+==================
+
+.. automodule:: gninatorch
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ gninatorch.dataloaders
+ gninatorch.gnina
+ gninatorch.inference
+ gninatorch.losses
+ gninatorch.metrics
+ gninatorch.models
+ gninatorch.setup
+ gninatorch.training
+ gninatorch.transforms
+ gninatorch.utils
diff --git a/docs/source/api/gninatorch.setup.rst b/docs/source/api/gninatorch.setup.rst
@@ -0,0 +1,7 @@
+gninatorch.setup module
+=======================
+
+.. automodule:: gninatorch.setup
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/gninatorch.training.rst b/docs/source/api/gninatorch.training.rst
@@ -0,0 +1,7 @@
+gninatorch.training module
+==========================
+
+.. automodule:: gninatorch.training
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/gninatorch.transforms.rst b/docs/source/api/gninatorch.transforms.rst
@@ -0,0 +1,7 @@
+gninatorch.transforms module
+============================
+
+.. automodule:: gninatorch.transforms
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/gninatorch.utils.rst b/docs/source/api/gninatorch.utils.rst
@@ -0,0 +1,7 @@
+gninatorch.utils module
+=======================
+
+.. automodule:: gninatorch.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
diff --git a/docs/getting_started.rst → docs/source/getting_started.rst b/docs/getting_started.rst → docs/source/getting_started.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
diff --git a/setup.py b/setup.py
@@ -44,12 +44,12 @@
  # url='http:https://www.my_package.com', # Website
  install_requires=[
  "torch",
- "pytorch-ignite",
  "molgrid",
  "numpy",
  ],
  extra_require={
  "all": [
+ "pytorch-ignite",
  "scipy",
  "pandas",
  "scikit-learn",