Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

# Get markdown files for the template schema from astrodb-template-db/ repository

template_schema_path = os.path.join("pages", "template_schema", "astrodb-template-db")
template_schema_path = os.path.join("pages", "getting_started", "template_schema", "astrodb-template-db")
if os.path.exists(template_schema_path):
template_repo = Repo(template_schema_path)
try:
Expand Down
24 changes: 8 additions & 16 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,16 @@ a package built on `SQLAlchemy <https://www.sqlalchemy.org/>`_.
User Guide
==================================


.. toctree::
:glob:
:maxdepth: 1

Overview of the AstroDB Toolkit <pages/overview/organization>
Installing astrodb-utils <pages/installation>
pages/loading/index
pages/querying_existing_db/index
pages/ingesting/index
pages/modifying/index
pages/make_new_db/index
pages/template_repo/index
pages/template_schema/template_schema
pages/making_private_version
pages/ingesting/spectra/converting_spectra/converting_spectra
pages/getting_help/index
Developer documentation <pages/dev_docs/developer_installation>
API documentation <pages/api>
:maxdepth: 2

pages/getting_started/index
pages/db_management/index
pages/db_access/index
pages/utilities/index
pages/reference/index


License & attribution
Expand Down
10 changes: 10 additions & 0 deletions docs/pages/db_access/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Working with databases
======================

.. toctree::
:glob:
:maxdepth: 2

loading/index
querying_existing_db/index
ingesting/getting_started_ingesting
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,10 @@ Ingesting and Modifying Data

ingest_scripts/index
ingesting_publications
spectra/*



.. note::
If you want to add or modify the tables or columns (rather than just add/modify database contents), see :doc:`/pages/modifying/index`.
If you want to add or modify the tables or columns (rather than just add/modify database contents), see :doc:`/pages/db_management/modifying/index`.


API Documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Ingesting publications
Below is an example script for ingesting the discovery publication for Rojas et al. 2012 into the SIMPLE Archive

.. code-block:: python

from astrodb_utils.publications import ingest_publication, find_publication
from astrodb_utils.loaders import read_db_from_file

Expand Down Expand Up @@ -57,7 +58,7 @@ Below is an example script for ingesting the discovery publication for Rojas et

.. seealso::

:doc:`../template_schema/lookup_tables/publications`
:doc:`/pages/getting_started/template_schema/lookup_tables/publications`
Documentation on the Publications table

:py:mod:`find publication <astrodb_utils.publications.find_publication>` function
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Querying
========
Querying the database
=====================

Create the Database
------------------------
Expand Down
9 changes: 9 additions & 0 deletions docs/pages/db_management/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Creating a New Database
========================

.. toctree::
:maxdepth: 2

make_new_db/index
modifying/index
making_private_version
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,8 @@ Making a New Database

.. toctree::
:glob:
:maxdepth: 1
:maxdepth: 2

new_repo
create_database
ingest_data



10 changes: 10 additions & 0 deletions docs/pages/getting_started/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Getting Started
===========================

.. toctree::
:maxdepth: 2

Overview of the AstroDB Toolkit <organization>
Installing astrodb-utils <installation>
template_repo/index
template_schema/template_schema
8 changes: 1 addition & 7 deletions docs/pages/api.rst → docs/pages/reference/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,11 @@ Publications
:members:
:undoc-members:
:show-inheritance:

Instruments
------------

.. automodule:: astrodb_utils.instruments
:members:
:undoc-members:
:show-inheritance:

Loaders
------------
.. automodule:: astrodb_utils.loaders
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ To build the docs, use `sphinx-autobuild <https://pypi.org/project/sphinx-autobu
.. code-block:: bash

pip install -e ".[docs]"
sphinx-autobuild docs docs/_build/html --ignore=docs/pages/template_schema/astrodb-template-db/.git/
sphinx-autobuild docs docs/_build/html --ignore=docs/pages/getting_started/template_schema/astrodb-template-db/

The docs will then be available locally at <http://127.0.0.1:8000>.
9 changes: 9 additions & 0 deletions docs/pages/reference/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Reference Information
=====================

.. toctree::
:glob:
:maxdepth: 2

developer_installation
api
9 changes: 9 additions & 0 deletions docs/pages/utilities/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Utilities and support
=====================

.. toctree::
:glob:
:maxdepth: 2

spectra/index
getting_help/index
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ to check if a spectrum is loadable by `astropy.specutils` and plottable.
The `matplotlib` package needs to be installed to display the spectrum using `show_plot=True`.

.. code-block:: python
from astrodb_utils.spectra import check_spectrum_plottable
file = <path to file>
plottable = check_spectrum_plottable(file, show_plot=True)
print plottable

from astrodb_utils.spectra import check_spectrum_plottable
file = <path to file>
plottable = check_spectrum_plottable(file, show_plot=True)
print plottable

> True
> True