Skip to content

Commit

Permalink
Adding updates to index, other docs
Browse files Browse the repository at this point in the history
These updates are to get the manuals compiling and showing on the main
pages.

There is still some signigicant work to do with updating references and
such, but it's already well on its way.
  • Loading branch information
teald committed Dec 11, 2023
1 parent e636184 commit 33ff98b
Show file tree
Hide file tree
Showing 5 changed files with 330 additions and 238 deletions.
82 changes: 82 additions & 0 deletions api/astrodata.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
astrodata package
=================

.. automodule:: astrodata
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

astrodata.core module
---------------------

.. automodule:: astrodata.core
:members:
:undoc-members:
:show-inheritance:

astrodata.factory module
------------------------

.. automodule:: astrodata.factory
:members:
:undoc-members:
:show-inheritance:

astrodata.fits module
---------------------

.. automodule:: astrodata.fits
:members:
:undoc-members:
:show-inheritance:

astrodata.nddata module
-----------------------

.. automodule:: astrodata.nddata
:members:
:undoc-members:
:show-inheritance:

astrodata.provenance module
---------------------------

.. automodule:: astrodata.provenance
:members:
:undoc-members:
:show-inheritance:

astrodata.testing module
------------------------

.. automodule:: astrodata.testing
:members:
:undoc-members:
:show-inheritance:

astrodata.utils module
----------------------

.. automodule:: astrodata.utils
:members:
:undoc-members:
:show-inheritance:

astrodata.version module
------------------------

.. automodule:: astrodata.version
:members:
:undoc-members:
:show-inheritance:

astrodata.wcs module
--------------------

.. automodule:: astrodata.wcs
:members:
:undoc-members:
:show-inheritance:
13 changes: 13 additions & 0 deletions docs/api_short.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Common API for Users
====================

This package contains the common API for users of the AstroData system. It
provides a single interface to the data, regardless of the format in which it
is stored.

If you would like a more extensive description of the astrodata package as a
user, see the |UserGuide|. If you are interested in developing with AstroData,
see the |DeveloperGuide|.

.. automodapi:: astrodata
:no-inheritance-diagram:
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ This is the documentation for astrodata.
:maxdepth: 2
:caption: Contents:

.. automodapi:: astrodata
:no-inheritance-diagram:
manuals/index
api_short


Indices and tables
==================
Expand Down
1 change: 0 additions & 1 deletion docs/manuals/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@ Reference API
:maxdepth: 1

api/astrodata
api/gemini_instruments
Loading

0 comments on commit 33ff98b

Please sign in to comment.