Skip to content
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

Jump to bottom

Documentation. Add drop-down for FBS scheduler pieces #18

Merged
merged 1 commit into from
Jan 3, 2024
Merged

Documentation. Add drop-down for FBS scheduler pieces #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions docs/fbs-api-basis-functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
11 changes: 11 additions & 0 deletions docs/fbs-api-detailers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. py:currentmodule:: rubin_scheduler.scheduler

.. _fbs-api-details:

Detailers
^^^^^^^^^

.. automodule:: rubin_scheduler.scheduler.detailers
:imported-members:
:members:
:show-inheritance:
12 changes: 12 additions & 0 deletions docs/fbs-api-example-scheduler.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
11 changes: 11 additions & 0 deletions docs/fbs-api-features.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. py:currentmodule:: rubin_scheduler.scheduler

.. _fbs-api-features:

Features
^^^^^^^^

.. automodule:: rubin_scheduler.scheduler.features
:imported-members:
:members:
:show-inheritance:
11 changes: 11 additions & 0 deletions docs/fbs-api-model-observatory.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
11 changes: 11 additions & 0 deletions docs/fbs-api-schedulers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. py:currentmodule:: rubin_scheduler.scheduler

.. _fbs-api-schedulers:

Schedulers
^^^^^^^^^^

.. automodule:: rubin_scheduler.scheduler.schedulers
:imported-members:
:members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/fbs-api-sim-runner.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. py:currentmodule:: rubin_scheduler.scheduler

.. _fbs-api-sim-runner:

Sim Runner
^^^^^^^^^^

.. automodule:: rubin_scheduler.scheduler.sim_runner
:members:
:show-inheritance:
11 changes: 11 additions & 0 deletions docs/fbs-api-surveys.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. py:currentmodule:: rubin_scheduler.scheduler

.. _fbs-api-surveys:

Surveys
^^^^^^^

.. automodule:: rubin_scheduler.scheduler.surveys
:imported-members:
:members:
:show-inheritance:
12 changes: 12 additions & 0 deletions docs/fbs-api-utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. py:currentmodule:: rubin_scheduler.scheduler

.. _fbs-api-utils:

Utils
^^^^^^

.. automodule:: rubin_scheduler.scheduler.utils
:imported-members:
:members:
:show-inheritance:

69 changes: 10 additions & 59 deletions docs/fbs-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,74 +6,25 @@
FBS Scheduler API
=================

Sim Runner
^^^^^^^^^^
.. toctree::

.. automodule:: rubin_scheduler.scheduler.sim_runner
:members:
:show-inheritance:
Sim Runner <fbs-api-sim-runner>

Example Scheduler
^^^^^^^^^^^^^^^^^
Example Scheduler <fbs-api-example-scheduler>

.. automodule:: rubin_scheduler.scheduler.example.example_scheduler
:imported-members:
:members:
:show-inheritance:
Model Observatory <fbs-api-model-observatory>

Model Observatory
^^^^^^^^^^^^^^^^^
Schedulers <fbs-api-schedulers>

.. automodule:: rubin_scheduler.scheduler.model_observatory
:imported-members:
:members:
:show-inheritance:
Surveys <fbs-api-surveys>

Schedulers
^^^^^^^^^^
Basis Functions <fbs-api-basis-functions>

.. automodule:: rubin_scheduler.scheduler.schedulers
:imported-members:
:members:
:show-inheritance:
Features <fbs-api-features>

Surveys
^^^^^^^
Detailers <fbs-api-detailers>

.. automodule:: rubin_scheduler.scheduler.surveys
:imported-members:
:members:
:show-inheritance:
Utils <fbs-api-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:

Loading