From 7960a8ed576f66c43b76969f42016ac825e9b2bb Mon Sep 17 00:00:00 2001 From: Gage Larsen Date: Sun, 18 Nov 2018 14:21:00 -0700 Subject: [PATCH] fixes for sphinx and versioning --- conanfile.py | 4 +-- pydocs/source/conf.py | 1 + pydocs/source/index.rst | 8 +++--- pydocs/source/modules.rst | 25 +++++++++++++++++++ pydocs/source/modules/stamper/XmGuidebank.rst | 6 +++++ .../modules/stamper/XmSlopedAbutment.rst | 6 +++++ .../modules/stamper/XmStampCrossSection.rst | 6 +++++ .../source/modules/stamper/XmStampRaster.rst | 6 +++++ pydocs/source/modules/stamper/XmStamper.rst | 6 +++++ .../stamper/XmStamperCenterlineProfile.rst | 6 +++++ .../modules/stamper/XmStamperEndCap.rst | 6 +++++ pydocs/source/modules/stamper/XmStamperIo.rst | 6 +++++ pydocs/source/modules/stamper/XmWingWall.rst | 6 +++++ 13 files changed, 85 insertions(+), 7 deletions(-) create mode 100644 pydocs/source/modules.rst create mode 100644 pydocs/source/modules/stamper/XmGuidebank.rst create mode 100644 pydocs/source/modules/stamper/XmSlopedAbutment.rst create mode 100644 pydocs/source/modules/stamper/XmStampCrossSection.rst create mode 100644 pydocs/source/modules/stamper/XmStampRaster.rst create mode 100644 pydocs/source/modules/stamper/XmStamper.rst create mode 100644 pydocs/source/modules/stamper/XmStamperCenterlineProfile.rst create mode 100644 pydocs/source/modules/stamper/XmStamperEndCap.rst create mode 100644 pydocs/source/modules/stamper/XmStamperIo.rst create mode 100644 pydocs/source/modules/stamper/XmWingWall.rst diff --git a/conanfile.py b/conanfile.py index 48c8807..f69c0e4 100644 --- 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 index 59f63fa..677e6cc 100644 --- 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 index 9303407..af42844 100644 --- 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 new file mode 100644 index 0000000..ff8fba6 --- /dev/null +++ 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 \ No newline at end of file diff --git a/pydocs/source/modules/stamper/XmGuidebank.rst b/pydocs/source/modules/stamper/XmGuidebank.rst new file mode 100644 index 0000000..722e6f0 --- /dev/null +++ b/pydocs/source/modules/stamper/XmGuidebank.rst @@ -0,0 +1,6 @@ +*********** +XmGuidebank +*********** + +.. autoclass:: xmsstamper_py.stamper.XmGuidebank + :members: \ No newline at end of file diff --git a/pydocs/source/modules/stamper/XmSlopedAbutment.rst b/pydocs/source/modules/stamper/XmSlopedAbutment.rst new file mode 100644 index 0000000..580503d --- /dev/null +++ b/pydocs/source/modules/stamper/XmSlopedAbutment.rst @@ -0,0 +1,6 @@ +**************** +XmSlopedAbutment +**************** + +.. autoclass:: xmsstamper_py.stamper.XmSlopedAbutment + :members: \ No newline at end of file diff --git a/pydocs/source/modules/stamper/XmStampCrossSection.rst b/pydocs/source/modules/stamper/XmStampCrossSection.rst new file mode 100644 index 0000000..6734157 --- /dev/null +++ b/pydocs/source/modules/stamper/XmStampCrossSection.rst @@ -0,0 +1,6 @@ +******************* +XmStampCrossSection +******************* + +.. autoclass:: xmsstamper_py.stamper.XmStampCrossSection + :members: \ No newline at end of file diff --git a/pydocs/source/modules/stamper/XmStampRaster.rst b/pydocs/source/modules/stamper/XmStampRaster.rst new file mode 100644 index 0000000..5470848 --- /dev/null +++ b/pydocs/source/modules/stamper/XmStampRaster.rst @@ -0,0 +1,6 @@ +************* +XmStampRaster +************* + +.. autoclass:: xmsstamper_py.stamper.XmStampRaster + :members: \ No newline at end of file diff --git a/pydocs/source/modules/stamper/XmStamper.rst b/pydocs/source/modules/stamper/XmStamper.rst new file mode 100644 index 0000000..d59610d --- /dev/null +++ b/pydocs/source/modules/stamper/XmStamper.rst @@ -0,0 +1,6 @@ +********* +XmStamper +********* + +.. autoclass:: xmsstamper_py.stamper.XmStamper + :members: \ No newline at end of file diff --git a/pydocs/source/modules/stamper/XmStamperCenterlineProfile.rst b/pydocs/source/modules/stamper/XmStamperCenterlineProfile.rst new file mode 100644 index 0000000..9c11283 --- /dev/null +++ b/pydocs/source/modules/stamper/XmStamperCenterlineProfile.rst @@ -0,0 +1,6 @@ +************************** +XmStamperCenterlineProfile +************************** + +.. autoclass:: xmsstamper_py.stamper.XmStamperCenterlineProfile + :members: \ No newline at end of file diff --git a/pydocs/source/modules/stamper/XmStamperEndCap.rst b/pydocs/source/modules/stamper/XmStamperEndCap.rst new file mode 100644 index 0000000..c82f91a --- /dev/null +++ b/pydocs/source/modules/stamper/XmStamperEndCap.rst @@ -0,0 +1,6 @@ +*************** +XmStamperEndCap +*************** + +.. autoclass:: xmsstamper_py.stamper.XmStamperEndCap + :members: \ No newline at end of file diff --git a/pydocs/source/modules/stamper/XmStamperIo.rst b/pydocs/source/modules/stamper/XmStamperIo.rst new file mode 100644 index 0000000..a4c9457 --- /dev/null +++ b/pydocs/source/modules/stamper/XmStamperIo.rst @@ -0,0 +1,6 @@ +*********** +XmStamperIo +*********** + +.. autoclass:: xmsstamper_py.stamper.XmStamperIo + :members: \ No newline at end of file diff --git a/pydocs/source/modules/stamper/XmWingWall.rst b/pydocs/source/modules/stamper/XmWingWall.rst new file mode 100644 index 0000000..5c618c5 --- /dev/null +++ b/pydocs/source/modules/stamper/XmWingWall.rst @@ -0,0 +1,6 @@ +********** +XmWingWall +********** + +.. autoclass:: xmsstamper_py.stamper.XmWingWall + :members: \ No newline at end of file