From 463cdc304f0bb29ff77e2b0c96cba9742b24defd Mon Sep 17 00:00:00 2001 From: Lynne Jones Date: Mon, 18 Dec 2023 17:41:51 -0800 Subject: [PATCH] Add drop-down for FBS scheduler pieces --- docs/fbs-api-basis-functions.rst | 11 +++++ docs/fbs-api-detailers.rst | 11 +++++ docs/fbs-api-example-scheduler.rst | 12 ++++++ docs/fbs-api-features.rst | 11 +++++ docs/fbs-api-model-observatory.rst | 11 +++++ docs/fbs-api-schedulers.rst | 11 +++++ docs/fbs-api-sim-runner.rst | 10 +++++ docs/fbs-api-surveys.rst | 11 +++++ docs/fbs-api-utils.rst | 12 ++++++ docs/fbs-api.rst | 69 +++++------------------------- 10 files changed, 110 insertions(+), 59 deletions(-) create mode 100644 docs/fbs-api-basis-functions.rst create mode 100644 docs/fbs-api-detailers.rst create mode 100644 docs/fbs-api-example-scheduler.rst create mode 100644 docs/fbs-api-features.rst create mode 100644 docs/fbs-api-model-observatory.rst create mode 100644 docs/fbs-api-schedulers.rst create mode 100644 docs/fbs-api-sim-runner.rst create mode 100644 docs/fbs-api-surveys.rst create mode 100644 docs/fbs-api-utils.rst diff --git a/docs/fbs-api-basis-functions.rst b/docs/fbs-api-basis-functions.rst new file mode 100644 index 00000000..955d8bff --- /dev/null +++ b/docs/fbs-api-basis-functions.rst @@ -0,0 +1,11 @@ +.. py:currentmodule:: rubin_scheduler.scheduler + +.. _fbs-api-basis-functions: + +Basis Functions +^^^^^^^^^^^^^^^ + +.. automodule:: rubin_scheduler.scheduler.basis_functions + :imported-members: + :members: + :show-inheritance: diff --git a/docs/fbs-api-detailers.rst b/docs/fbs-api-detailers.rst new file mode 100644 index 00000000..14dbdfec --- /dev/null +++ b/docs/fbs-api-detailers.rst @@ -0,0 +1,11 @@ +.. py:currentmodule:: rubin_scheduler.scheduler + +.. _fbs-api-details: + +Detailers +^^^^^^^^^ + +.. automodule:: rubin_scheduler.scheduler.detailers + :imported-members: + :members: + :show-inheritance: diff --git a/docs/fbs-api-example-scheduler.rst b/docs/fbs-api-example-scheduler.rst new file mode 100644 index 00000000..4d2d0e13 --- /dev/null +++ b/docs/fbs-api-example-scheduler.rst @@ -0,0 +1,12 @@ +.. py:currentmodule:: rubin_scheduler.scheduler + +.. _fbs-api-example-scheduler: + + +Example Scheduler +^^^^^^^^^^^^^^^^^ + +.. automodule:: rubin_scheduler.scheduler.example.example_scheduler + :imported-members: + :members: + :show-inheritance: diff --git a/docs/fbs-api-features.rst b/docs/fbs-api-features.rst new file mode 100644 index 00000000..658bd506 --- /dev/null +++ b/docs/fbs-api-features.rst @@ -0,0 +1,11 @@ +.. py:currentmodule:: rubin_scheduler.scheduler + +.. _fbs-api-features: + +Features +^^^^^^^^ + +.. automodule:: rubin_scheduler.scheduler.features + :imported-members: + :members: + :show-inheritance: diff --git a/docs/fbs-api-model-observatory.rst b/docs/fbs-api-model-observatory.rst new file mode 100644 index 00000000..3340ad0b --- /dev/null +++ b/docs/fbs-api-model-observatory.rst @@ -0,0 +1,11 @@ +.. py:currentmodule:: rubin_scheduler.scheduler + +.. _fbs-api-model-observatory: + +Model Observatory +^^^^^^^^^^^^^^^^^ + +.. automodule:: rubin_scheduler.scheduler.model_observatory + :imported-members: + :members: + :show-inheritance: diff --git a/docs/fbs-api-schedulers.rst b/docs/fbs-api-schedulers.rst new file mode 100644 index 00000000..95cd5843 --- /dev/null +++ b/docs/fbs-api-schedulers.rst @@ -0,0 +1,11 @@ +.. py:currentmodule:: rubin_scheduler.scheduler + +.. _fbs-api-schedulers: + +Schedulers +^^^^^^^^^^ + +.. automodule:: rubin_scheduler.scheduler.schedulers + :imported-members: + :members: + :show-inheritance: diff --git a/docs/fbs-api-sim-runner.rst b/docs/fbs-api-sim-runner.rst new file mode 100644 index 00000000..d6a2c932 --- /dev/null +++ b/docs/fbs-api-sim-runner.rst @@ -0,0 +1,10 @@ +.. py:currentmodule:: rubin_scheduler.scheduler + +.. _fbs-api-sim-runner: + +Sim Runner +^^^^^^^^^^ + +.. automodule:: rubin_scheduler.scheduler.sim_runner + :members: + :show-inheritance: diff --git a/docs/fbs-api-surveys.rst b/docs/fbs-api-surveys.rst new file mode 100644 index 00000000..3ebb9359 --- /dev/null +++ b/docs/fbs-api-surveys.rst @@ -0,0 +1,11 @@ +.. py:currentmodule:: rubin_scheduler.scheduler + +.. _fbs-api-surveys: + +Surveys +^^^^^^^ + +.. automodule:: rubin_scheduler.scheduler.surveys + :imported-members: + :members: + :show-inheritance: diff --git a/docs/fbs-api-utils.rst b/docs/fbs-api-utils.rst new file mode 100644 index 00000000..dcf4f3a5 --- /dev/null +++ b/docs/fbs-api-utils.rst @@ -0,0 +1,12 @@ +.. py:currentmodule:: rubin_scheduler.scheduler + +.. _fbs-api-utils: + +Utils +^^^^^^ + +.. automodule:: rubin_scheduler.scheduler.utils + :imported-members: + :members: + :show-inheritance: + diff --git a/docs/fbs-api.rst b/docs/fbs-api.rst index a0c3e0fb..3042f0dd 100644 --- a/docs/fbs-api.rst +++ b/docs/fbs-api.rst @@ -6,74 +6,25 @@ FBS Scheduler API ================= -Sim Runner -^^^^^^^^^^ +.. toctree:: -.. automodule:: rubin_scheduler.scheduler.sim_runner - :members: - :show-inheritance: + Sim Runner -Example Scheduler -^^^^^^^^^^^^^^^^^ + Example Scheduler -.. automodule:: rubin_scheduler.scheduler.example.example_scheduler - :imported-members: - :members: - :show-inheritance: + Model Observatory -Model Observatory -^^^^^^^^^^^^^^^^^ + Schedulers -.. automodule:: rubin_scheduler.scheduler.model_observatory - :imported-members: - :members: - :show-inheritance: + Surveys -Schedulers -^^^^^^^^^^ + Basis Functions -.. automodule:: rubin_scheduler.scheduler.schedulers - :imported-members: - :members: - :show-inheritance: + Features -Surveys -^^^^^^^ + Detailers -.. automodule:: rubin_scheduler.scheduler.surveys - :imported-members: - :members: - :show-inheritance: + Utils -Basis Functions -^^^^^^^^^^^^^^^ -.. automodule:: rubin_scheduler.scheduler.basis_functions - :imported-members: - :members: - :show-inheritance: - -Features -^^^^^^^^ - -.. automodule:: rubin_scheduler.scheduler.features - :imported-members: - :members: - :show-inheritance: - -Detailers -^^^^^^^^^ - -.. automodule:: rubin_scheduler.scheduler.detailers - :imported-members: - :members: - :show-inheritance: - -Utils -^^^^^^ - -.. automodule:: rubin_scheduler.scheduler.utils - :imported-members: - :members: - :show-inheritance: