Merge pull request #63 from UC-Davis-molecular-computing/dev

Dev
UC-Davis-molecular-computing · May 30, 2020 · 10cf39d · 10cf39d
2 parents 9d30c54 + 60368ee
commit 10cf39d
Show file tree

Hide file tree

Showing 58 changed files with 3,605 additions and 98 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -16,7 +16,9 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../'))
+import scadnano
+
+sys.path.insert(0, os.path.abspath('../scadnano'))
 # print(sys.path)
 
 # Type "make html" at the command line to generate the documentation.
@@ -29,8 +31,10 @@
 author = 'David Doty'
 
 # The full version, including alpha/beta/rc tags
-version = '0.0.1'
-release = '0.0.1'
+# version = '0.7.0'
+# release = '0.7.0'
+version = scadnano.current_version
+release = scadnano.current_version
 
 # -- General configuration ---------------------------------------------------
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -12,28 +12,28 @@ scadnano documentation
 
 scadnano 
 =====================
-.. automodule:: scadnano.scadnano
+.. automodule:: scadnano
    :members:
 
 origami_rectangle 
 =====================
-.. automodule:: scadnano.origami_rectangle
+.. automodule:: origami_rectangle
    :members:
 
 Interoperability - cadnano v2
 =============================
 
 Scadnano provides function to convert design to and from cadnano v2:
 
-* :any:`DNADesign.from_cadnano_v2` will create a scadnano DNADesign from a ``cadnanov2`` json file. 
-* :any:`DNADesign.export_cadnano_v2` will produce a ``cadnanov2`` json file from a scadnano design.
+* :py:meth:`DNADesign.from_cadnano_v2` will create a scadnano DNADesign from a ``cadnanov2`` json file.
+* :py:meth:`DNADesign.export_cadnano_v2` will produce a ``cadnanov2`` json file from a scadnano design.
 
 **Important**
 
 All ``cadnanov2`` designs can be imported to scadnano. However **not all scadnano designs can be imported 
 to cadnanov2**, to be importable to ``cadnanov2`` a scadnano design need to comply with the following points:
 
-* The design cannot feature any :any:`Loopout` as it is not a concept that exists in ``cadnanov2``.
+* The design cannot feature any :py:class:`Loopout` as it is not a concept that exists in ``cadnanov2``.
 * Following ``cadnanov2`` conventions, helices with **even** number must have their scaffold going **forward** and helices with **odd** number **backward**.
 
 Also note that maximum helices offsets can be altered in a ``scadnano`` to ``cadnanov2`` conversion as ``cadnanov2`` needs max offsets to be a multiple of 21 in the hex grid and 32 in the rectangular grid.