diff --git a/docs/pages/template_schema/data_tables/companionparameters.rst b/docs/pages/template_schema/data_tables/companionparameters.rst index 56e54a2..4e5c81b 100644 --- a/docs/pages/template_schema/data_tables/companionparameters.rst +++ b/docs/pages/template_schema/data_tables/companionparameters.rst @@ -3,7 +3,7 @@ CompanionParameters .. seealso:: - :doc:`../lookup_tables/paramaterlist` + :doc:`../lookup_tables/parameterlist` Documentation for the ParamaterList table :doc:`companion_relationships` diff --git a/docs/pages/template_schema/data_tables/photometry.rst b/docs/pages/template_schema/data_tables/photometry.rst index 6c9f79d..398f35a 100644 --- a/docs/pages/template_schema/data_tables/photometry.rst +++ b/docs/pages/template_schema/data_tables/photometry.rst @@ -9,6 +9,9 @@ Notes .. seealso:: + :py:mod:`ingest_photometry` + Function to ingest photometry data + :doc:`../lookup_tables/photometryfilters` Documentation for the PhotometryFilters table diff --git a/docs/pages/template_schema/data_tables/spectra.rst b/docs/pages/template_schema/data_tables/spectra.rst index 73da4fb..1b3c460 100644 --- a/docs/pages/template_schema/data_tables/spectra.rst +++ b/docs/pages/template_schema/data_tables/spectra.rst @@ -9,6 +9,9 @@ Spectra :doc:`../lookup_tables/regimelist` Documentation for the RegimeList table` + :py:mod:`check_spectrum_plottable` + Function to check if a spectrum is plottable + Relevant functions: `spectra.ingest_spectrum`, `spectra.spectrum_plottable`, `spectra.find_spectra` diff --git a/docs/pages/template_schema/lookup_tables/instruments.rst b/docs/pages/template_schema/lookup_tables/instruments.rst index aaa65b4..98a1ca1 100644 --- a/docs/pages/template_schema/lookup_tables/instruments.rst +++ b/docs/pages/template_schema/lookup_tables/instruments.rst @@ -3,6 +3,9 @@ Instruments .. seealso:: + :py:mod:`ingest_instrument` + Function to ingest instrument data + :doc:`../lookup_tables/telescopes` Documentation for the Telescopes table diff --git a/docs/pages/template_schema/lookup_tables/photometryfilters.rst b/docs/pages/template_schema/lookup_tables/photometryfilters.rst index 28bdb5f..a027f79 100644 --- a/docs/pages/template_schema/lookup_tables/photometryfilters.rst +++ b/docs/pages/template_schema/lookup_tables/photometryfilters.rst @@ -25,13 +25,13 @@ Notes :doc:`../data_tables/photometry` Documentation for the Photometry table - :py:mod:`ingest_photometry_filter ` function + :py:mod:`ingest_photometry_filter ` Function to ingest photometry filters - :py:mod:`fetch_svo ` function + :py:mod:`fetch_svo ` Function to fetch SVO filter profiles - :py:mod:`assign_ucd ` function + :py:mod:`assign_ucd ` Function to assign UCDs to photometry filters Table documentation diff --git a/docs/pages/template_schema/lookup_tables/publications.rst b/docs/pages/template_schema/lookup_tables/publications.rst index 1a0ae6c..b4ce5f8 100644 --- a/docs/pages/template_schema/lookup_tables/publications.rst +++ b/docs/pages/template_schema/lookup_tables/publications.rst @@ -17,9 +17,11 @@ Notes :ref:`ingesting_publications` Documenation on ingesting publications - :py:mod:`find publication ` function - - :py:mod:`ingest_publication ` function + :py:mod:`ingest_publication ` + Function to ingest publication data + + :py:mod:`find publication ` + Function to find publications in the database Table documentation diff --git a/docs/pages/template_schema/main_tables/index.rst b/docs/pages/template_schema/main_tables/index.rst index 9eab20e..0eb8319 100644 --- a/docs/pages/template_schema/main_tables/index.rst +++ b/docs/pages/template_schema/main_tables/index.rst @@ -7,3 +7,4 @@ Main tables sources names + versions diff --git a/docs/pages/template_schema/main_tables/names.rst b/docs/pages/template_schema/main_tables/names.rst index 6c5a3b2..f7bfef2 100644 --- a/docs/pages/template_schema/main_tables/names.rst +++ b/docs/pages/template_schema/main_tables/names.rst @@ -1,2 +1,17 @@ +Names +##### + +.. seealso:: + :py:mod:`ingest_name` + Function to ingest name data + + +Table Documentation +=================== +.. _source: https://github.com/astrodbtoolkit/astrodb-template-db/blob/main/docs/schema/Names.md + +The below table is built directly from the schema and is +included here from the `astrodb-template-db` documentation: `source`_. + .. mdinclude:: ../../../../astrodb-template-db/docs/schema/Names.md diff --git a/docs/pages/template_schema/main_tables/sources.rst b/docs/pages/template_schema/main_tables/sources.rst index 307ee35..0dae4d2 100644 --- a/docs/pages/template_schema/main_tables/sources.rst +++ b/docs/pages/template_schema/main_tables/sources.rst @@ -14,6 +14,14 @@ Notes * In the case of multiple discovery references, for example independent discovery, choose one reference for the `reference` column and put the rest in the `other_references` column. +.. seealso:: + + :py:mod:`ingest_source` + Function to ingest source data + + :py:mod:`find_source_in_db` + Function to find sources in the database + Table documentation ------------------- diff --git a/pyproject.toml b/pyproject.toml index 17cd6e1..3774af7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,6 +44,7 @@ docs = [ "nbsphinx", "pydata-sphinx-theme", "pandoc", + "sphinx_mdinclude", ] all = ["astrodb_utils[test, docs]"]