Skip to content

Commit

Permalink
Add back attrs to docs (#157)
Browse files Browse the repository at this point in the history
* Add back attrs to docs

* Apply suggestions from code review

---------

Co-authored-by: Nabil Freij <nabil.freij@gmail.com>
  • Loading branch information
Cadair and nabobalis authored Oct 3, 2024
1 parent e75767c commit ba767a8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,19 @@ Reference/API
=============

.. automodapi:: sunpy_soar
:no-inheritance-diagram:

.. automodapi:: sunpy_soar.attrs
:no-inheritance-diagram:


.. note::

All attrs for sunpy_soar should be accessed as follows:

.. code-block:: python
import sunpy_soar
from sunpy.net import Fido, attrs as a
a.soar.Product

0 comments on commit ba767a8

Please sign in to comment.