Skip to content

Commit

Permalink
DOC: changed API documentation to reflect function location
Browse files Browse the repository at this point in the history
if spectrum_colors is available from skued's base package, it should
also be reflected in the API documentation
  • Loading branch information
LaurentRDC committed Jul 11, 2017
1 parent 0a22986 commit b7fb675
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ Reference/API

Parallel Utilities
==================
.. automodule:: skued.parallel
.. autofunction:: skued.pmap

.. autofunction:: skued.preduce

Plot Utilities
==============
.. autofunction:: skued.plot_utils.spectrum_colors
.. autofunction:: skued.spectrum_colors

.. autofunction:: skued.plot_utils.rgb_sweep
.. autofunction:: skued.rgb_sweep

Array Utilities
===============
Expand All @@ -32,17 +34,14 @@ Affine Transforms

Structure
=========
.. autoclass:: skued.structure.atom.Atom
.. autoclass:: skued.structure.Atom
:members:
:undoc-members:

.. autoclass:: skued.structure.lattice.Lattice
.. autoclass:: skued.structure.Lattice
:members:
:undoc-members:

.. autoclass:: skued.structure.crystal.Crystal
.. autoclass:: skued.structure.Crystal
:members:
:undoc-members:

Simulation
==========
Expand Down

0 comments on commit b7fb675

Please sign in to comment.