-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
36 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
API References | ||
============== | ||
|
||
Overview | ||
-------- | ||
- :class:`splinepy.splinepy_core` is a module that includes all the c++ bindings. Most importantly, :class:`.PySpline` and :class:`.PyMultiPatch` are implemented here, which serve bases for all the derived spline types with in the library. It only contains minimal documentation, as the classes and methods are derived / integrated throughout the library with proper documentations on python side. | ||
- :class:`.Spline` extends / documents :class:`.PySpline`. Common features for all splines are implemented here. We recommend using :class:`.Bezier`, :class:`.RationalBezier`, :class:`.BSpline`, or :class:`.NURBS` in front-end applications. | ||
- :class:`.BezierBase` extends :class:`.Spline` with features available for Bezier-families. It becomes a basis for :class:`.Bezier` and :class:`.RationalBezier`, where the derived classes implement appropriate initializations. | ||
- :class:`.BSplineBase` extends :class:`.Spline` with features available for BSpline-famlilies. It becomes a basis for :class:`.BSpline` and :class:`.NURBS`, where derived classes implements appropriate initializations. | ||
- :class:`.Multipatch` extends / documents :class:`.PyMultiPatch`. | ||
- :class:`splinepy.helpme` module contains useful application-driven tools / utility functions. | ||
|
||
|
||
splinepy | ||
-------- | ||
.. toctree:: | ||
full_api |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,6 @@ | ||
API references | ||
-------------- | ||
|
||
.. autosummary:: | ||
:toctree: _autosummary | ||
:template: | ||
:recursive: | ||
|
||
splinepy | ||
splinepy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters