Skip to content

Commit

Permalink
Fix up API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ixjlyons committed Sep 2, 2023
1 parent eff4e4c commit 35cf213
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

clean:
rm -rf api/*
rm -rf "$(BUILDDIR)"
rm -rf auto_*/


.PHONY: help clean Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
Expand Down
43 changes: 23 additions & 20 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,36 @@
API
===

.. currentmodule:: ndsplines

.. rubric:: Creation routines

Routines for creating ``NDSpline`` objects.
Routines for creating :class:`NDSpline` objects.

.. autosummary::
:toctree: api

~ndsplines.make_lsq_spline
~ndsplines.make_interp_spline
~ndsplines.make_interp_spline_from_tidy
~ndsplines.from_file
make_lsq_spline
make_interp_spline
make_interp_spline_from_tidy
from_file

.. rubric:: Class methods

Methods of the :doc:`api/ndsplines.NDSpline` class.
Methods of the :class:`NDSpline` class.

.. autosummary::
:toctree: api

~ndsplines.NDSpline
~ndsplines.NDSpline.__call__
~ndsplines.NDSpline.derivative
~ndsplines.NDSpline.antiderivative
~ndsplines.NDSpline.to_file
~ndsplines.NDSpline.copy
~ndsplines.NDSpline.__eq__
~ndsplines.NDSpline.allocate_workspace_arrays
~ndsplines.NDSpline.compute_basis_coefficient_selector
NDSpline
NDSpline.__call__
NDSpline.derivative
NDSpline.antiderivative
NDSpline.to_file
NDSpline.copy
NDSpline.__eq__
NDSpline.allocate_workspace_arrays
NDSpline.compute_basis_coefficient_selector

.. rubric:: Knots

Expand All @@ -37,7 +40,7 @@ Utility function for constructing knot arrays.
.. autosummary::
:toctree: api

~ndsplines._not_a_knot
_not_a_knot

.. rubric:: Implementations

Expand All @@ -47,7 +50,7 @@ evaluation.
.. autosummary::
:toctree: api

~ndsplines.set_impl
~ndsplines.get_impl
~ndsplines._bspl
~ndsplines._npy_bspl
set_impl
get_impl
_bspl
_npy_bspl

0 comments on commit 35cf213

Please sign in to comment.