Skip to content

Doc tweaks #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 17, 2025
Merged

Doc tweaks #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d6cc7d3
versions
kelle Apr 17, 2025
6032360
parameterlist
kelle Apr 17, 2025
713ac34
add links to relevant functions
kelle Apr 17, 2025
7343c39
add sphinx_mdinclude to requirements
kelle Apr 17, 2025
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/pages/template_schema/data_tables/companionparameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ CompanionParameters

.. seealso::

:doc:`../lookup_tables/paramaterlist`
:doc:`../lookup_tables/parameterlist`
Documentation for the ParamaterList table

:doc:`companion_relationships`
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/template_schema/data_tables/photometry.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ Notes

.. seealso::

:py:mod:`ingest_photometry<astrodb_utils.photometry.ingest_photometry>`
Function to ingest photometry data

:doc:`../lookup_tables/photometryfilters`
Documentation for the PhotometryFilters table

Expand Down
3 changes: 3 additions & 0 deletions docs/pages/template_schema/data_tables/spectra.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ Spectra
:doc:`../lookup_tables/regimelist`
Documentation for the RegimeList table`

:py:mod:`check_spectrum_plottable<astrodb_utils.spectra.check_spectrum_plottable>`
Function to check if a spectrum is plottable


Relevant functions: `spectra.ingest_spectrum`, `spectra.spectrum_plottable`, `spectra.find_spectra`

Expand Down
3 changes: 3 additions & 0 deletions docs/pages/template_schema/lookup_tables/instruments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ Instruments

.. seealso::

:py:mod:`ingest_instrument<astrodb_utils.utils.ingest_instrument>`
Function to ingest instrument data

:doc:`../lookup_tables/telescopes`
Documentation for the Telescopes table

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/template_schema/lookup_tables/photometryfilters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ Notes
:doc:`../data_tables/photometry`
Documentation for the Photometry table

:py:mod:`ingest_photometry_filter <astrodb_utils.photometry.ingest_photometry_filter>` function
:py:mod:`ingest_photometry_filter <astrodb_utils.photometry.ingest_photometry_filter>`
Function to ingest photometry filters

:py:mod:`fetch_svo <astrodb_utils.photometry.fetch_svo>` function
:py:mod:`fetch_svo <astrodb_utils.photometry.fetch_svo>`
Function to fetch SVO filter profiles

:py:mod:`assign_ucd <astrodb_utils.photometry.assign_ucd>` function
:py:mod:`assign_ucd <astrodb_utils.photometry.assign_ucd>`
Function to assign UCDs to photometry filters

Table documentation
Expand Down
8 changes: 5 additions & 3 deletions docs/pages/template_schema/lookup_tables/publications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@ Notes
:ref:`ingesting_publications`
Documenation on ingesting publications

:py:mod:`find publication <astrodb_utils.publications.find_publication>` function

:py:mod:`ingest_publication <astrodb_utils.publications.ingest_publication>` function
:py:mod:`ingest_publication <astrodb_utils.publications.ingest_publication>`
Function to ingest publication data

:py:mod:`find publication <astrodb_utils.publications.find_publication>`
Function to find publications in the database


Table documentation
Expand Down
1 change: 1 addition & 0 deletions docs/pages/template_schema/main_tables/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ Main tables

sources
names
versions
15 changes: 15 additions & 0 deletions docs/pages/template_schema/main_tables/names.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
Names
#####

.. seealso::
:py:mod:`ingest_name<astrodb_utils.names.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

8 changes: 8 additions & 0 deletions docs/pages/template_schema/main_tables/sources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<astrodb_utils.sources.ingest_source>`
Function to ingest source data

:py:mod:`find_source_in_db<astrodb_utils.sources.find_source_in_db>`
Function to find sources in the database


Table documentation
-------------------
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ docs = [
"nbsphinx",
"pydata-sphinx-theme",
"pandoc",
"sphinx_mdinclude",
]
all = ["astrodb_utils[test, docs]"]

Expand Down