fixes for sphinx and versioning

Aquaveo · Nov 19, 2018 · 7960a8e · 7960a8e
1 parent a359322
commit 7960a8e
Show file tree

Hide file tree

Showing 13 changed files with 85 additions and 7 deletions.
diff --git a/conanfile.py b/conanfile.py
@@ -64,8 +64,8 @@ def requirements(self):
             self.requires("pybind11/2.2.2@aquaveo/stable")
 
         # Use the dev version of XMSCore, XMSInterp, XMSGrid, XMSExtractor
-        self.requires("xmscore/[>=1.0.40]@aquaveo/stable")
-        self.requires("xmsinterp/[>=1.0.19]@aquaveo/stable")
+        self.requires("xmscore/[>=1.0.43,<2.0]@aquaveo/stable")
+        self.requires("xmsinterp/[>=1.0.23,<2.0]@aquaveo/stable")
 
     def build(self):
         cmake = CMake(self)

diff --git a/pydocs/source/conf.py b/pydocs/source/conf.py
@@ -15,6 +15,7 @@
 import os
 import sys
 sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath(os.path.join('..', '..', 'build', 'lib')))
 
 
 # -- Project information -----------------------------------------------------

diff --git a/pydocs/source/index.rst b/pydocs/source/index.rst
@@ -3,17 +3,14 @@
    :width: 250px
    :align: right
 
-*******************
+********************
 XmsStamper |version|
-*******************
+********************
 
 **Last Updated:** October 5, 2018
 
 The xmsstamper library is a stamping library for other aquaveo products. This library contains classes used to create stamping.
 
-.. note::
-
-    Documentation coming soon!
 
 Contents
 ========
@@ -22,6 +19,7 @@ Contents
    :maxdepth: 1
 
    gettingstarted
+   modules
 
 Acknowledgements
 ================

diff --git a/pydocs/source/modules.rst b/pydocs/source/modules.rst
@@ -0,0 +1,25 @@
+*******
+Modules
+*******
+
+**Last Update:** October 5, 2018
+
+These are the modules currently exposed to python from the xmsstamper library
+
+stamper
+=======
+
+.. automodule:: xmsstamper_py.stamper
+
+.. toctree::
+   :maxdepth: 1
+
+   modules/stamper/XmStamper
+   modules/stamper/XmStamperIo.rst
+   modules/stamper/XmStampRaster
+   modules/stamper/XmGuidebank
+   modules/stamper/XmSlopedAbutment
+   modules/stamper/XmStampCrossSection
+   modules/stamper/XmStamperCenterlineProfile
+   modules/stamper/XmStamperEndCap
+   modules/stamper/XmWingWall
diff --git a/pydocs/source/modules/stamper/XmGuidebank.rst b/pydocs/source/modules/stamper/XmGuidebank.rst
@@ -0,0 +1,6 @@
+***********
+XmGuidebank
+***********
+
+.. autoclass:: xmsstamper_py.stamper.XmGuidebank
+   :members:
diff --git a/pydocs/source/modules/stamper/XmSlopedAbutment.rst b/pydocs/source/modules/stamper/XmSlopedAbutment.rst
@@ -0,0 +1,6 @@
+****************
+XmSlopedAbutment
+****************
+
+.. autoclass:: xmsstamper_py.stamper.XmSlopedAbutment
+   :members:
diff --git a/pydocs/source/modules/stamper/XmStampCrossSection.rst b/pydocs/source/modules/stamper/XmStampCrossSection.rst
@@ -0,0 +1,6 @@
+*******************
+XmStampCrossSection
+*******************
+
+.. autoclass:: xmsstamper_py.stamper.XmStampCrossSection
+   :members:
diff --git a/pydocs/source/modules/stamper/XmStampRaster.rst b/pydocs/source/modules/stamper/XmStampRaster.rst
@@ -0,0 +1,6 @@
+*************
+XmStampRaster
+*************
+
+.. autoclass:: xmsstamper_py.stamper.XmStampRaster
+   :members:
diff --git a/pydocs/source/modules/stamper/XmStamper.rst b/pydocs/source/modules/stamper/XmStamper.rst
@@ -0,0 +1,6 @@
+*********
+XmStamper
+*********
+
+.. autoclass:: xmsstamper_py.stamper.XmStamper
+   :members:
diff --git a/pydocs/source/modules/stamper/XmStamperCenterlineProfile.rst b/pydocs/source/modules/stamper/XmStamperCenterlineProfile.rst
@@ -0,0 +1,6 @@
+**************************
+XmStamperCenterlineProfile
+**************************
+
+.. autoclass:: xmsstamper_py.stamper.XmStamperCenterlineProfile
+   :members:
diff --git a/pydocs/source/modules/stamper/XmStamperEndCap.rst b/pydocs/source/modules/stamper/XmStamperEndCap.rst
@@ -0,0 +1,6 @@
+***************
+XmStamperEndCap
+***************
+
+.. autoclass:: xmsstamper_py.stamper.XmStamperEndCap
+   :members:
diff --git a/pydocs/source/modules/stamper/XmStamperIo.rst b/pydocs/source/modules/stamper/XmStamperIo.rst
@@ -0,0 +1,6 @@
+***********
+XmStamperIo
+***********
+
+.. autoclass:: xmsstamper_py.stamper.XmStamperIo
+   :members:
diff --git a/pydocs/source/modules/stamper/XmWingWall.rst b/pydocs/source/modules/stamper/XmWingWall.rst
@@ -0,0 +1,6 @@
+**********
+XmWingWall
+**********
+
+.. autoclass:: xmsstamper_py.stamper.XmWingWall
+   :members: