Skip to content

Commit

Permalink
docs: ✍️ Add information to package docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
teald committed Aug 15, 2024
1 parent 729bf18 commit d968cad
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion astrodata/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
"""This package adds an abstraction layer to astronomical data by parsing the
"""Entry point for the |astrodata| package.
This package adds an abstraction layer to astronomical data by parsing the
information contained in the headers as attributes. To do so, one must subclass
:class:`astrodata.AstroData` and add parse methods accordingly to the
:class:`~astrodata.TagSet` received.
For more information, you can build the documentation locally by running
.. code-block:: bash
nox -s docs
and opening the file ``_build/html/index.html`` in a browser. Alternatively,
you can check the online documentation at
`the |astrodata| pages site <https://geminidrsoftware.github.io/astrodata/>`_.
"""

import importlib.metadata
Expand Down

0 comments on commit d968cad

Please sign in to comment.