From 8a9482c35a1c57f879209c75d5130c3ae866965e Mon Sep 17 00:00:00 2001 From: Lauren Adoram-Kershner <42873279+ladoramkershner@users.noreply.github.com> Date: Tue, 16 Mar 2021 11:14:37 -0700 Subject: [PATCH] Doc badge (#405) * initial commit * updating master doc * reorganizing landing page * heckin mv everything up a dir * forgot to switch main index file * firing off doxygen build before RTD --- README.md | 2 +- docs/conf.py | 8 ++++++++ docs/index.rst | 3 ++- docs/{source => }/library/capi/distortion.rst | 0 docs/{source => }/library/capi/index.rst | 0 docs/{source => }/library/capi/interp_utils.rst | 0 docs/{source => }/library/capi/isd.rst | 0 docs/{source => }/library/capi/orientation.rst | 0 docs/{source => }/library/capi/rotation.rst | 0 docs/{source => }/library/capi/state.rst | 0 docs/{source => }/library/capi/util.rst | 0 docs/{source => }/library/capi/vector.rst | 0 docs/{source => }/library/index.rst | 0 docs/{source => }/library/python/base.rst | 0 .../library/python/concrete_drivers/co_driver.rst | 0 .../library/python/concrete_drivers/dawn_driver.rst | 0 .../python/concrete_drivers/hayabusa2_driver.rst | 0 .../library/python/concrete_drivers/index.rst | 0 .../python/concrete_drivers/isis_ideal_driver.rst | 0 .../library/python/concrete_drivers/juno_driver.rst | 0 .../library/python/concrete_drivers/lro_driver.rst | 0 .../library/python/concrete_drivers/mess_driver.rst | 0 .../library/python/concrete_drivers/mex_driver.rst | 0 .../library/python/concrete_drivers/mro_driver.rst | 0 .../library/python/concrete_drivers/nh_driver.rst | 0 .../library/python/concrete_drivers/ody_driver.rst | 0 .../python/concrete_drivers/selene_driver.rst | 0 .../library/python/concrete_drivers/tgo_driver.rst | 0 .../python/concrete_drivers/viking_driver.rst | 0 .../python/concrete_drivers/voyager_driver.rst | 0 docs/{source => }/library/python/index.rst | 0 .../library/python/mix_ins/distortion_model.rst | 0 docs/{source => }/library/python/mix_ins/index.rst | 0 .../library/python/mix_ins/label_data.rst | 0 .../library/python/mix_ins/sensor_type.rst | 0 .../library/python/mix_ins/supplementary_data.rst | 0 docs/{source => }/library/python/rotation.rst | 0 docs/{source => }/library/python/transformation.rst | 0 docs/{source => }/library/python/util.rst | 0 docs/source/index.rst | 12 ------------ docs/{source => }/tutorials/index.rst | 0 docs/{source => }/tutorials/quick_start.rst | 0 42 files changed, 11 insertions(+), 14 deletions(-) rename docs/{source => }/library/capi/distortion.rst (100%) rename docs/{source => }/library/capi/index.rst (100%) rename docs/{source => }/library/capi/interp_utils.rst (100%) rename docs/{source => }/library/capi/isd.rst (100%) rename docs/{source => }/library/capi/orientation.rst (100%) rename docs/{source => }/library/capi/rotation.rst (100%) rename docs/{source => }/library/capi/state.rst (100%) rename docs/{source => }/library/capi/util.rst (100%) rename docs/{source => }/library/capi/vector.rst (100%) rename docs/{source => }/library/index.rst (100%) rename docs/{source => }/library/python/base.rst (100%) rename docs/{source => }/library/python/concrete_drivers/co_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/dawn_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/hayabusa2_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/index.rst (100%) rename docs/{source => }/library/python/concrete_drivers/isis_ideal_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/juno_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/lro_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/mess_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/mex_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/mro_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/nh_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/ody_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/selene_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/tgo_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/viking_driver.rst (100%) rename docs/{source => }/library/python/concrete_drivers/voyager_driver.rst (100%) rename docs/{source => }/library/python/index.rst (100%) rename docs/{source => }/library/python/mix_ins/distortion_model.rst (100%) rename docs/{source => }/library/python/mix_ins/index.rst (100%) rename docs/{source => }/library/python/mix_ins/label_data.rst (100%) rename docs/{source => }/library/python/mix_ins/sensor_type.rst (100%) rename docs/{source => }/library/python/mix_ins/supplementary_data.rst (100%) rename docs/{source => }/library/python/rotation.rst (100%) rename docs/{source => }/library/python/transformation.rst (100%) rename docs/{source => }/library/python/util.rst (100%) delete mode 100644 docs/source/index.rst rename docs/{source => }/tutorials/index.rst (100%) rename docs/{source => }/tutorials/quick_start.rst (100%) diff --git a/README.md b/README.md index 4d1493e..f55b0bd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Abstraction Layer for Ephemerides (ALE) [](https://travis-ci.org/USGS-Astrogeology/ale) [](https://coveralls.io/github/USGS-Astrogeology/ale?branch=master) -[](https://usgs-astrogeology.github.io/ale/) +[](https://ale.readthedocs.io/en/latest/?badge=latest) diff --git a/docs/conf.py b/docs/conf.py index 72889e1..bce72af 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,3 +56,11 @@ html_theme = 'alabaster' # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] + +# -- Run Doxygen for C++ API -------------------------------------------------- +import subprocess, os + +read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' + +if read_the_docs_build: + subprocess.call('cd ../doxygen; doxygen', shell=True) diff --git a/docs/index.rst b/docs/index.rst index 6ddd187..741b84a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,4 +8,5 @@ Abstraction Layer for Ephemerides (ALE) .. toctree:: :maxdepth: 3 - source/index + tutorials/index + library/index diff --git a/docs/source/library/capi/distortion.rst b/docs/library/capi/distortion.rst similarity index 100% rename from docs/source/library/capi/distortion.rst rename to docs/library/capi/distortion.rst diff --git a/docs/source/library/capi/index.rst b/docs/library/capi/index.rst similarity index 100% rename from docs/source/library/capi/index.rst rename to docs/library/capi/index.rst diff --git a/docs/source/library/capi/interp_utils.rst b/docs/library/capi/interp_utils.rst similarity index 100% rename from docs/source/library/capi/interp_utils.rst rename to docs/library/capi/interp_utils.rst diff --git a/docs/source/library/capi/isd.rst b/docs/library/capi/isd.rst similarity index 100% rename from docs/source/library/capi/isd.rst rename to docs/library/capi/isd.rst diff --git a/docs/source/library/capi/orientation.rst b/docs/library/capi/orientation.rst similarity index 100% rename from docs/source/library/capi/orientation.rst rename to docs/library/capi/orientation.rst diff --git a/docs/source/library/capi/rotation.rst b/docs/library/capi/rotation.rst similarity index 100% rename from docs/source/library/capi/rotation.rst rename to docs/library/capi/rotation.rst diff --git a/docs/source/library/capi/state.rst b/docs/library/capi/state.rst similarity index 100% rename from docs/source/library/capi/state.rst rename to docs/library/capi/state.rst diff --git a/docs/source/library/capi/util.rst b/docs/library/capi/util.rst similarity index 100% rename from docs/source/library/capi/util.rst rename to docs/library/capi/util.rst diff --git a/docs/source/library/capi/vector.rst b/docs/library/capi/vector.rst similarity index 100% rename from docs/source/library/capi/vector.rst rename to docs/library/capi/vector.rst diff --git a/docs/source/library/index.rst b/docs/library/index.rst similarity index 100% rename from docs/source/library/index.rst rename to docs/library/index.rst diff --git a/docs/source/library/python/base.rst b/docs/library/python/base.rst similarity index 100% rename from docs/source/library/python/base.rst rename to docs/library/python/base.rst diff --git a/docs/source/library/python/concrete_drivers/co_driver.rst b/docs/library/python/concrete_drivers/co_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/co_driver.rst rename to docs/library/python/concrete_drivers/co_driver.rst diff --git a/docs/source/library/python/concrete_drivers/dawn_driver.rst b/docs/library/python/concrete_drivers/dawn_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/dawn_driver.rst rename to docs/library/python/concrete_drivers/dawn_driver.rst diff --git a/docs/source/library/python/concrete_drivers/hayabusa2_driver.rst b/docs/library/python/concrete_drivers/hayabusa2_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/hayabusa2_driver.rst rename to docs/library/python/concrete_drivers/hayabusa2_driver.rst diff --git a/docs/source/library/python/concrete_drivers/index.rst b/docs/library/python/concrete_drivers/index.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/index.rst rename to docs/library/python/concrete_drivers/index.rst diff --git a/docs/source/library/python/concrete_drivers/isis_ideal_driver.rst b/docs/library/python/concrete_drivers/isis_ideal_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/isis_ideal_driver.rst rename to docs/library/python/concrete_drivers/isis_ideal_driver.rst diff --git a/docs/source/library/python/concrete_drivers/juno_driver.rst b/docs/library/python/concrete_drivers/juno_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/juno_driver.rst rename to docs/library/python/concrete_drivers/juno_driver.rst diff --git a/docs/source/library/python/concrete_drivers/lro_driver.rst b/docs/library/python/concrete_drivers/lro_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/lro_driver.rst rename to docs/library/python/concrete_drivers/lro_driver.rst diff --git a/docs/source/library/python/concrete_drivers/mess_driver.rst b/docs/library/python/concrete_drivers/mess_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/mess_driver.rst rename to docs/library/python/concrete_drivers/mess_driver.rst diff --git a/docs/source/library/python/concrete_drivers/mex_driver.rst b/docs/library/python/concrete_drivers/mex_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/mex_driver.rst rename to docs/library/python/concrete_drivers/mex_driver.rst diff --git a/docs/source/library/python/concrete_drivers/mro_driver.rst b/docs/library/python/concrete_drivers/mro_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/mro_driver.rst rename to docs/library/python/concrete_drivers/mro_driver.rst diff --git a/docs/source/library/python/concrete_drivers/nh_driver.rst b/docs/library/python/concrete_drivers/nh_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/nh_driver.rst rename to docs/library/python/concrete_drivers/nh_driver.rst diff --git a/docs/source/library/python/concrete_drivers/ody_driver.rst b/docs/library/python/concrete_drivers/ody_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/ody_driver.rst rename to docs/library/python/concrete_drivers/ody_driver.rst diff --git a/docs/source/library/python/concrete_drivers/selene_driver.rst b/docs/library/python/concrete_drivers/selene_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/selene_driver.rst rename to docs/library/python/concrete_drivers/selene_driver.rst diff --git a/docs/source/library/python/concrete_drivers/tgo_driver.rst b/docs/library/python/concrete_drivers/tgo_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/tgo_driver.rst rename to docs/library/python/concrete_drivers/tgo_driver.rst diff --git a/docs/source/library/python/concrete_drivers/viking_driver.rst b/docs/library/python/concrete_drivers/viking_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/viking_driver.rst rename to docs/library/python/concrete_drivers/viking_driver.rst diff --git a/docs/source/library/python/concrete_drivers/voyager_driver.rst b/docs/library/python/concrete_drivers/voyager_driver.rst similarity index 100% rename from docs/source/library/python/concrete_drivers/voyager_driver.rst rename to docs/library/python/concrete_drivers/voyager_driver.rst diff --git a/docs/source/library/python/index.rst b/docs/library/python/index.rst similarity index 100% rename from docs/source/library/python/index.rst rename to docs/library/python/index.rst diff --git a/docs/source/library/python/mix_ins/distortion_model.rst b/docs/library/python/mix_ins/distortion_model.rst similarity index 100% rename from docs/source/library/python/mix_ins/distortion_model.rst rename to docs/library/python/mix_ins/distortion_model.rst diff --git a/docs/source/library/python/mix_ins/index.rst b/docs/library/python/mix_ins/index.rst similarity index 100% rename from docs/source/library/python/mix_ins/index.rst rename to docs/library/python/mix_ins/index.rst diff --git a/docs/source/library/python/mix_ins/label_data.rst b/docs/library/python/mix_ins/label_data.rst similarity index 100% rename from docs/source/library/python/mix_ins/label_data.rst rename to docs/library/python/mix_ins/label_data.rst diff --git a/docs/source/library/python/mix_ins/sensor_type.rst b/docs/library/python/mix_ins/sensor_type.rst similarity index 100% rename from docs/source/library/python/mix_ins/sensor_type.rst rename to docs/library/python/mix_ins/sensor_type.rst diff --git a/docs/source/library/python/mix_ins/supplementary_data.rst b/docs/library/python/mix_ins/supplementary_data.rst similarity index 100% rename from docs/source/library/python/mix_ins/supplementary_data.rst rename to docs/library/python/mix_ins/supplementary_data.rst diff --git a/docs/source/library/python/rotation.rst b/docs/library/python/rotation.rst similarity index 100% rename from docs/source/library/python/rotation.rst rename to docs/library/python/rotation.rst diff --git a/docs/source/library/python/transformation.rst b/docs/library/python/transformation.rst similarity index 100% rename from docs/source/library/python/transformation.rst rename to docs/library/python/transformation.rst diff --git a/docs/source/library/python/util.rst b/docs/library/python/util.rst similarity index 100% rename from docs/source/library/python/util.rst rename to docs/library/python/util.rst diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index a86e817..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -############################# -Abstraction Layer for Ephemerides (ALE) -############################# - -:Release: |version| -:Date: |today| - -.. toctree:: - :maxdepth: 3 - - library/index - tutorials/index diff --git a/docs/source/tutorials/index.rst b/docs/tutorials/index.rst similarity index 100% rename from docs/source/tutorials/index.rst rename to docs/tutorials/index.rst diff --git a/docs/source/tutorials/quick_start.rst b/docs/tutorials/quick_start.rst similarity index 100% rename from docs/source/tutorials/quick_start.rst rename to docs/tutorials/quick_start.rst -- GitLab