Fixed some RTD documentaion issues

#5
radxtools · Sep 17, 2020 · ac1394f · ac1394f
1 parent c4073f9
commit ac1394f
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 4 deletions.
diff --git a/src/docs/source/classes.rst b/src/docs/source/classes.rst
@@ -0,0 +1,14 @@
+============
+Classes
+============
+
+.. toctree::
+   :maxdepth: 2
+
+.. autoclass:: topology_radiomics.config.MarchingCubesAlgorithm
+.. autoclass:: topology_radiomics.config.MorphologyConfig
+.. autoclass:: topology_radiomics.morphology_features.Curvature
+.. autoclass:: topology_radiomics.morphology_features.SurfaceMeasures
+.. autoclass:: topology_radiomics.morphology_features.Isosurface
+.. autoclass:: topology_radiomics.morphology_features.MorphologyFeatures
+.. autoclass:: topology_radiomics.sanitization.BinaryVoxelMask
diff --git a/src/docs/source/conf.py b/src/docs/source/conf.py
@@ -17,7 +17,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'bric-morphology'
+project = 'topology_radiomics'
 copyright = '2020, Toth Techonologies'
 author = 'Toth Techonologies'
 

diff --git a/src/docs/source/index.rst b/src/docs/source/index.rst
@@ -1,15 +1,24 @@
-.. bric-morphology documentation master file, created by
+.. topology_radiomics documentation master file, created by
    sphinx-quickstart on Sun Sep  6 01:56:31 2020.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to bric-morphology's documentation!
-===========================================
+Getting started guide
+=====================
+
+You can install the package using: pip install topology-radiomics
+
+
+If you prefer docker, you can find more info here:
+https://hub.docker.com/repository/docker/radxtools/topology-radiomics-examples
+
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   classes
+
 
 
 Indices and tables