v0.3.0 Add mkdocs documentation, improved docstrings, convert output to standard Python data types.
LatestWhat's Changed
- 7 make nice docs by @tpprytula in #15
-
Improved docstrings of the exposed functions, and turn them into google format
-
Built and deployed Mkdocs website for the project with the documentation, demo notebooks, and a description of the package and the algorithm itself
-
BREAKING CHANGE: as specified by the docstrings in previous versions, the output of
create_sn_graphfunction is now a tuple consisting of:- list of tuples of integers for spheres centres coordinates
- list of tuples of pairs of vertex coordinates for edges
- optional np.ndarray for sdf_array
For the most practical uses this change will not break any workflow, as iterating over the new output format goes the same as iterating over the previous one.
-
Full Changelog: v0.2.0...v0.3.0