diff --git a/docs/conf.py b/docs/conf.py index 2cca1be..6f9c3e8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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: diff --git a/docs/index.rst b/docs/index.rst index ee35e28..8605b32 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,24 +14,16 @@ a package built on `SQLAlchemy `_. User Guide ================================== + .. toctree:: :glob: - :maxdepth: 1 - - Overview of the AstroDB Toolkit - Installing astrodb-utils - 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 - API documentation + :maxdepth: 2 + + pages/getting_started/index + pages/db_management/index + pages/db_access/index + pages/utilities/index + pages/reference/index License & attribution diff --git a/docs/pages/db_access/index.rst b/docs/pages/db_access/index.rst new file mode 100644 index 0000000..4be3063 --- /dev/null +++ b/docs/pages/db_access/index.rst @@ -0,0 +1,10 @@ +Working with databases +====================== + +.. toctree:: + :glob: + :maxdepth: 2 + + loading/index + querying_existing_db/index + ingesting/getting_started_ingesting diff --git a/docs/pages/ingesting/index.rst b/docs/pages/db_access/ingesting/getting_started_ingesting.rst similarity index 85% rename from docs/pages/ingesting/index.rst rename to docs/pages/db_access/ingesting/getting_started_ingesting.rst index 099c862..51ca77f 100644 --- a/docs/pages/ingesting/index.rst +++ b/docs/pages/db_access/ingesting/getting_started_ingesting.rst @@ -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 diff --git a/docs/pages/ingesting/ingest_scripts/index.rst b/docs/pages/db_access/ingesting/ingest_scripts/index.rst similarity index 100% rename from docs/pages/ingesting/ingest_scripts/index.rst rename to docs/pages/db_access/ingesting/ingest_scripts/index.rst diff --git a/docs/pages/ingesting/ingest_scripts/writing_scripts.rst b/docs/pages/db_access/ingesting/ingest_scripts/writing_scripts.rst similarity index 100% rename from docs/pages/ingesting/ingest_scripts/writing_scripts.rst rename to docs/pages/db_access/ingesting/ingest_scripts/writing_scripts.rst diff --git a/docs/pages/ingesting/ingesting_publications.rst b/docs/pages/db_access/ingesting/ingesting_publications.rst similarity index 96% rename from docs/pages/ingesting/ingesting_publications.rst rename to docs/pages/db_access/ingesting/ingesting_publications.rst index 9434ac2..73e1341 100644 --- a/docs/pages/ingesting/ingesting_publications.rst +++ b/docs/pages/db_access/ingesting/ingesting_publications.rst @@ -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 @@ -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 ` function diff --git a/docs/pages/loading/command_line.rst b/docs/pages/db_access/loading/command_line.rst similarity index 100% rename from docs/pages/loading/command_line.rst rename to docs/pages/db_access/loading/command_line.rst diff --git a/docs/pages/loading/index.rst b/docs/pages/db_access/loading/index.rst similarity index 100% rename from docs/pages/loading/index.rst rename to docs/pages/db_access/loading/index.rst diff --git a/docs/pages/querying_existing_db/index.rst b/docs/pages/db_access/querying_existing_db/index.rst similarity index 98% rename from docs/pages/querying_existing_db/index.rst rename to docs/pages/db_access/querying_existing_db/index.rst index e1946c0..63227ba 100644 --- a/docs/pages/querying_existing_db/index.rst +++ b/docs/pages/db_access/querying_existing_db/index.rst @@ -1,5 +1,5 @@ -Querying -======== +Querying the database +===================== Create the Database ------------------------ diff --git a/docs/pages/db_management/index.rst b/docs/pages/db_management/index.rst new file mode 100644 index 0000000..2019181 --- /dev/null +++ b/docs/pages/db_management/index.rst @@ -0,0 +1,9 @@ +Creating a New Database +======================== + +.. toctree:: + :maxdepth: 2 + + make_new_db/index + modifying/index + making_private_version diff --git a/docs/pages/make_new_db/create_database.rst b/docs/pages/db_management/make_new_db/create_database.rst similarity index 100% rename from docs/pages/make_new_db/create_database.rst rename to docs/pages/db_management/make_new_db/create_database.rst diff --git a/docs/pages/make_new_db/index.rst b/docs/pages/db_management/make_new_db/index.rst similarity index 85% rename from docs/pages/make_new_db/index.rst rename to docs/pages/db_management/make_new_db/index.rst index a003479..c7fd2c5 100644 --- a/docs/pages/make_new_db/index.rst +++ b/docs/pages/db_management/make_new_db/index.rst @@ -3,11 +3,8 @@ Making a New Database .. toctree:: :glob: - :maxdepth: 1 + :maxdepth: 2 new_repo create_database ingest_data - - - diff --git a/docs/pages/make_new_db/ingest_data.rst b/docs/pages/db_management/make_new_db/ingest_data.rst similarity index 100% rename from docs/pages/make_new_db/ingest_data.rst rename to docs/pages/db_management/make_new_db/ingest_data.rst diff --git a/docs/pages/make_new_db/new_repo.rst b/docs/pages/db_management/make_new_db/new_repo.rst similarity index 100% rename from docs/pages/make_new_db/new_repo.rst rename to docs/pages/db_management/make_new_db/new_repo.rst diff --git a/docs/pages/making_private_version.rst b/docs/pages/db_management/making_private_version.rst similarity index 100% rename from docs/pages/making_private_version.rst rename to docs/pages/db_management/making_private_version.rst diff --git a/docs/pages/modifying/index.rst b/docs/pages/db_management/modifying/index.rst similarity index 100% rename from docs/pages/modifying/index.rst rename to docs/pages/db_management/modifying/index.rst diff --git a/docs/pages/modifying/new_columns.rst b/docs/pages/db_management/modifying/new_columns.rst similarity index 100% rename from docs/pages/modifying/new_columns.rst rename to docs/pages/db_management/modifying/new_columns.rst diff --git a/docs/pages/modifying/new_tables.rst b/docs/pages/db_management/modifying/new_tables.rst similarity index 100% rename from docs/pages/modifying/new_tables.rst rename to docs/pages/db_management/modifying/new_tables.rst diff --git a/docs/pages/modifying/yaml.rst b/docs/pages/db_management/modifying/yaml.rst similarity index 100% rename from docs/pages/modifying/yaml.rst rename to docs/pages/db_management/modifying/yaml.rst diff --git a/docs/pages/getting_started/index.rst b/docs/pages/getting_started/index.rst new file mode 100644 index 0000000..db71530 --- /dev/null +++ b/docs/pages/getting_started/index.rst @@ -0,0 +1,10 @@ +Getting Started +=========================== + +.. toctree:: + :maxdepth: 2 + + Overview of the AstroDB Toolkit + Installing astrodb-utils + template_repo/index + template_schema/template_schema \ No newline at end of file diff --git a/docs/pages/installation.rst b/docs/pages/getting_started/installation.rst similarity index 100% rename from docs/pages/installation.rst rename to docs/pages/getting_started/installation.rst diff --git a/docs/pages/overview/organization.rst b/docs/pages/getting_started/organization.rst similarity index 100% rename from docs/pages/overview/organization.rst rename to docs/pages/getting_started/organization.rst diff --git a/docs/pages/overview/repo_organization.png b/docs/pages/getting_started/repo_organization.png similarity index 100% rename from docs/pages/overview/repo_organization.png rename to docs/pages/getting_started/repo_organization.png diff --git a/docs/pages/template_repo/index.rst b/docs/pages/getting_started/template_repo/index.rst similarity index 100% rename from docs/pages/template_repo/index.rst rename to docs/pages/getting_started/template_repo/index.rst diff --git a/docs/pages/template_repo/workflows.rst b/docs/pages/getting_started/template_repo/workflows.rst similarity index 100% rename from docs/pages/template_repo/workflows.rst rename to docs/pages/getting_started/template_repo/workflows.rst diff --git a/docs/pages/template_schema/data_tables/associations.rst b/docs/pages/getting_started/template_schema/data_tables/associations.rst similarity index 100% rename from docs/pages/template_schema/data_tables/associations.rst rename to docs/pages/getting_started/template_schema/data_tables/associations.rst diff --git a/docs/pages/template_schema/data_tables/companion_relationships.rst b/docs/pages/getting_started/template_schema/data_tables/companion_relationships.rst similarity index 100% rename from docs/pages/template_schema/data_tables/companion_relationships.rst rename to docs/pages/getting_started/template_schema/data_tables/companion_relationships.rst diff --git a/docs/pages/template_schema/data_tables/companionparameters.rst b/docs/pages/getting_started/template_schema/data_tables/companionparameters.rst similarity index 100% rename from docs/pages/template_schema/data_tables/companionparameters.rst rename to docs/pages/getting_started/template_schema/data_tables/companionparameters.rst diff --git a/docs/pages/template_schema/data_tables/index.rst b/docs/pages/getting_started/template_schema/data_tables/index.rst similarity index 100% rename from docs/pages/template_schema/data_tables/index.rst rename to docs/pages/getting_started/template_schema/data_tables/index.rst diff --git a/docs/pages/template_schema/data_tables/modeledparameters.rst b/docs/pages/getting_started/template_schema/data_tables/modeledparameters.rst similarity index 100% rename from docs/pages/template_schema/data_tables/modeledparameters.rst rename to docs/pages/getting_started/template_schema/data_tables/modeledparameters.rst diff --git a/docs/pages/template_schema/data_tables/parallaxes.rst b/docs/pages/getting_started/template_schema/data_tables/parallaxes.rst similarity index 100% rename from docs/pages/template_schema/data_tables/parallaxes.rst rename to docs/pages/getting_started/template_schema/data_tables/parallaxes.rst diff --git a/docs/pages/template_schema/data_tables/photometry.rst b/docs/pages/getting_started/template_schema/data_tables/photometry.rst similarity index 100% rename from docs/pages/template_schema/data_tables/photometry.rst rename to docs/pages/getting_started/template_schema/data_tables/photometry.rst diff --git a/docs/pages/template_schema/data_tables/propermotions.rst b/docs/pages/getting_started/template_schema/data_tables/propermotions.rst similarity index 100% rename from docs/pages/template_schema/data_tables/propermotions.rst rename to docs/pages/getting_started/template_schema/data_tables/propermotions.rst diff --git a/docs/pages/template_schema/data_tables/radialvelocities.rst b/docs/pages/getting_started/template_schema/data_tables/radialvelocities.rst similarity index 100% rename from docs/pages/template_schema/data_tables/radialvelocities.rst rename to docs/pages/getting_started/template_schema/data_tables/radialvelocities.rst diff --git a/docs/pages/template_schema/data_tables/rotationalparameters.rst b/docs/pages/getting_started/template_schema/data_tables/rotationalparameters.rst similarity index 100% rename from docs/pages/template_schema/data_tables/rotationalparameters.rst rename to docs/pages/getting_started/template_schema/data_tables/rotationalparameters.rst diff --git a/docs/pages/template_schema/data_tables/sourcetypes.rst b/docs/pages/getting_started/template_schema/data_tables/sourcetypes.rst similarity index 100% rename from docs/pages/template_schema/data_tables/sourcetypes.rst rename to docs/pages/getting_started/template_schema/data_tables/sourcetypes.rst diff --git a/docs/pages/template_schema/data_tables/spectra.rst b/docs/pages/getting_started/template_schema/data_tables/spectra.rst similarity index 100% rename from docs/pages/template_schema/data_tables/spectra.rst rename to docs/pages/getting_started/template_schema/data_tables/spectra.rst diff --git a/docs/pages/template_schema/lookup_tables/associationlist.rst b/docs/pages/getting_started/template_schema/lookup_tables/associationlist.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/associationlist.rst rename to docs/pages/getting_started/template_schema/lookup_tables/associationlist.rst diff --git a/docs/pages/template_schema/lookup_tables/companionlist.rst b/docs/pages/getting_started/template_schema/lookup_tables/companionlist.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/companionlist.rst rename to docs/pages/getting_started/template_schema/lookup_tables/companionlist.rst diff --git a/docs/pages/template_schema/lookup_tables/index.rst b/docs/pages/getting_started/template_schema/lookup_tables/index.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/index.rst rename to docs/pages/getting_started/template_schema/lookup_tables/index.rst diff --git a/docs/pages/template_schema/lookup_tables/instruments.rst b/docs/pages/getting_started/template_schema/lookup_tables/instruments.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/instruments.rst rename to docs/pages/getting_started/template_schema/lookup_tables/instruments.rst diff --git a/docs/pages/template_schema/lookup_tables/parameterlist.rst b/docs/pages/getting_started/template_schema/lookup_tables/parameterlist.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/parameterlist.rst rename to docs/pages/getting_started/template_schema/lookup_tables/parameterlist.rst diff --git a/docs/pages/template_schema/lookup_tables/photometryfilters.rst b/docs/pages/getting_started/template_schema/lookup_tables/photometryfilters.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/photometryfilters.rst rename to docs/pages/getting_started/template_schema/lookup_tables/photometryfilters.rst diff --git a/docs/pages/template_schema/lookup_tables/publications.rst b/docs/pages/getting_started/template_schema/lookup_tables/publications.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/publications.rst rename to docs/pages/getting_started/template_schema/lookup_tables/publications.rst diff --git a/docs/pages/template_schema/lookup_tables/regimelist.rst b/docs/pages/getting_started/template_schema/lookup_tables/regimelist.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/regimelist.rst rename to docs/pages/getting_started/template_schema/lookup_tables/regimelist.rst diff --git a/docs/pages/template_schema/lookup_tables/sourcetypelist.rst b/docs/pages/getting_started/template_schema/lookup_tables/sourcetypelist.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/sourcetypelist.rst rename to docs/pages/getting_started/template_schema/lookup_tables/sourcetypelist.rst diff --git a/docs/pages/template_schema/lookup_tables/telescopes.rst b/docs/pages/getting_started/template_schema/lookup_tables/telescopes.rst similarity index 100% rename from docs/pages/template_schema/lookup_tables/telescopes.rst rename to docs/pages/getting_started/template_schema/lookup_tables/telescopes.rst diff --git a/docs/pages/template_schema/main_tables/index.rst b/docs/pages/getting_started/template_schema/main_tables/index.rst similarity index 100% rename from docs/pages/template_schema/main_tables/index.rst rename to docs/pages/getting_started/template_schema/main_tables/index.rst diff --git a/docs/pages/template_schema/main_tables/names.rst b/docs/pages/getting_started/template_schema/main_tables/names.rst similarity index 100% rename from docs/pages/template_schema/main_tables/names.rst rename to docs/pages/getting_started/template_schema/main_tables/names.rst diff --git a/docs/pages/template_schema/main_tables/sources.rst b/docs/pages/getting_started/template_schema/main_tables/sources.rst similarity index 100% rename from docs/pages/template_schema/main_tables/sources.rst rename to docs/pages/getting_started/template_schema/main_tables/sources.rst diff --git a/docs/pages/template_schema/main_tables/versions.rst b/docs/pages/getting_started/template_schema/main_tables/versions.rst similarity index 100% rename from docs/pages/template_schema/main_tables/versions.rst rename to docs/pages/getting_started/template_schema/main_tables/versions.rst diff --git a/docs/pages/template_schema/template_schema.rst b/docs/pages/getting_started/template_schema/template_schema.rst similarity index 100% rename from docs/pages/template_schema/template_schema.rst rename to docs/pages/getting_started/template_schema/template_schema.rst diff --git a/docs/pages/api.rst b/docs/pages/reference/api.rst similarity index 89% rename from docs/pages/api.rst rename to docs/pages/reference/api.rst index f1ba2e8..1f74053 100644 --- a/docs/pages/api.rst +++ b/docs/pages/reference/api.rst @@ -53,6 +53,7 @@ Publications :members: :undoc-members: :show-inheritance: + Instruments ------------ @@ -60,10 +61,3 @@ Instruments :members: :undoc-members: :show-inheritance: - -Loaders ------------- -.. automodule:: astrodb_utils.loaders - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file diff --git a/docs/pages/dev_docs/developer_installation.rst b/docs/pages/reference/developer_installation.rst similarity index 100% rename from docs/pages/dev_docs/developer_installation.rst rename to docs/pages/reference/developer_installation.rst diff --git a/docs/pages/dev_docs/documentation.rst b/docs/pages/reference/documentation.rst similarity index 80% rename from docs/pages/dev_docs/documentation.rst rename to docs/pages/reference/documentation.rst index 9343a02..63ac828 100644 --- a/docs/pages/dev_docs/documentation.rst +++ b/docs/pages/reference/documentation.rst @@ -16,6 +16,6 @@ To build the docs, use `sphinx-autobuild . diff --git a/docs/pages/reference/index.rst b/docs/pages/reference/index.rst new file mode 100644 index 0000000..a4da8f5 --- /dev/null +++ b/docs/pages/reference/index.rst @@ -0,0 +1,9 @@ +Reference Information +===================== + +.. toctree:: + :glob: + :maxdepth: 2 + + developer_installation + api \ No newline at end of file diff --git a/docs/pages/dev_docs/ingest_functions.rst b/docs/pages/reference/ingest_functions.rst similarity index 100% rename from docs/pages/dev_docs/ingest_functions.rst rename to docs/pages/reference/ingest_functions.rst diff --git a/docs/pages/getting_help/faq.rst b/docs/pages/utilities/getting_help/faq.rst similarity index 100% rename from docs/pages/getting_help/faq.rst rename to docs/pages/utilities/getting_help/faq.rst diff --git a/docs/pages/getting_help/index.rst b/docs/pages/utilities/getting_help/index.rst similarity index 100% rename from docs/pages/getting_help/index.rst rename to docs/pages/utilities/getting_help/index.rst diff --git a/docs/pages/utilities/index.rst b/docs/pages/utilities/index.rst new file mode 100644 index 0000000..f7dc765 --- /dev/null +++ b/docs/pages/utilities/index.rst @@ -0,0 +1,9 @@ +Utilities and support +===================== + +.. toctree:: + :glob: + :maxdepth: 2 + + spectra/index + getting_help/index diff --git a/docs/pages/ingesting/spectra/converting_spectra/converting_spectra.rst b/docs/pages/utilities/spectra/converting_spectra/converting_spectra.rst similarity index 100% rename from docs/pages/ingesting/spectra/converting_spectra/converting_spectra.rst rename to docs/pages/utilities/spectra/converting_spectra/converting_spectra.rst diff --git a/docs/pages/ingesting/spectra/converting_spectra/fits_header_modify.ipynb b/docs/pages/utilities/spectra/converting_spectra/fits_header_modify.ipynb similarity index 100% rename from docs/pages/ingesting/spectra/converting_spectra/fits_header_modify.ipynb rename to docs/pages/utilities/spectra/converting_spectra/fits_header_modify.ipynb diff --git a/docs/pages/ingesting/spectra/converting_spectra/fits_header_scratch.ipynb b/docs/pages/utilities/spectra/converting_spectra/fits_header_scratch.ipynb similarity index 100% rename from docs/pages/ingesting/spectra/converting_spectra/fits_header_scratch.ipynb rename to docs/pages/utilities/spectra/converting_spectra/fits_header_scratch.ipynb diff --git a/docs/pages/ingesting/spectra/index.rst b/docs/pages/utilities/spectra/index.rst similarity index 71% rename from docs/pages/ingesting/spectra/index.rst rename to docs/pages/utilities/spectra/index.rst index 83def96..c9c85f4 100644 --- a/docs/pages/ingesting/spectra/index.rst +++ b/docs/pages/utilities/spectra/index.rst @@ -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 = - plottable = check_spectrum_plottable(file, show_plot=True) - print plottable + + from astrodb_utils.spectra import check_spectrum_plottable + file = + plottable = check_spectrum_plottable(file, show_plot=True) + print plottable - > True + > True