Skip to content

Commit a48f702

Browse files
michaelayeclaude
andcommitted
Update quartodoc config for mro module reorganization
- Move instruments.ctx and instruments.hirise to instruments.mro.* - Regenerate API reference files for new module structure - Remove stale reference files for old module paths Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 922a4ab commit a48f702

File tree

9 files changed

+27
-266
lines changed

9 files changed

+27
-266
lines changed

docs/_quarto.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ quartodoc:
120120

121121
- title: Instruments
122122
contents:
123-
- instruments.ctx
123+
- instruments.mro.ctx
124+
- instruments.mro.hirise
124125
- instruments.go_ssi
125-
- instruments.hirise
126126
- instruments.utils

docs/reference/_sidebar.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ website:
2727
- reference/spice.pckernels.qmd
2828
section: SPICE Kernels
2929
- contents:
30-
- reference/instruments.ctx.qmd
30+
- reference/instruments.mro.ctx.qmd
31+
- reference/instruments.mro.hirise.qmd
3132
- reference/instruments.go_ssi.qmd
32-
- reference/instruments.hirise.qmd
3333
- reference/instruments.utils.qmd
3434
section: Instruments
3535
id: reference

docs/reference/exceptions.qmd

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,12 @@ exceptions.SomethingNotSetError(where, what)
4646

4747
Exception raised for errors in the input of transformations.
4848

49-
Attributes:
50-
where: Where something is missing.
51-
what: What is missing.
49+
#### Parameters {.doc-section .doc-section-parameters}
50+
51+
| Name | Type | Description | Default |
52+
|--------|--------|-----------------------------|------------|
53+
| where | | Where something is missing. | _required_ |
54+
| what | | What is missing. | _required_ |
5255

5356
### SpicerError { #planetarypy.exceptions.SpicerError }
5457

docs/reference/index.qmd

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
---
2-
title: API Reference
3-
---
4-
5-
Welcome to the API Reference. Here you’ll find detailed documentation for all modules and functions in PlanetaryPy.
1+
# API Reference {.doc .doc-index}
62

73
## Core Modules
84

@@ -47,7 +43,7 @@ Helpers for SPICE kernels and configuration.
4743

4844
| | |
4945
| --- | --- |
50-
| [instruments.ctx](instruments.ctx.qmd#planetarypy.instruments.ctx) | Module for dealing with CTX data. |
46+
| [instruments.mro.ctx](instruments.mro.ctx.qmd#planetarypy.instruments.mro.ctx) | CTX instrument package for MRO. |
47+
| [instruments.mro.hirise](instruments.mro.hirise.qmd#planetarypy.instruments.mro.hirise) | |
5148
| [instruments.go_ssi](instruments.go_ssi.qmd#planetarypy.instruments.go_ssi) | |
52-
| [instruments.hirise](instruments.hirise.qmd#planetarypy.instruments.hirise) | |
5349
| [instruments.utils](instruments.utils.qmd#planetarypy.instruments.utils) | |

docs/reference/instruments.ctx.qmd

Lines changed: 0 additions & 216 deletions
This file was deleted.

docs/reference/instruments.hirise.qmd

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# instruments.mro.ctx { #planetarypy.instruments.mro.ctx }
2+
3+
`instruments.mro.ctx`
4+
5+
CTX instrument package for MRO.
6+
7+
This package provides tools for working with MRO CTX data.
8+
9+
Example usage:
10+
from planetarypy.instruments.mro.ctx import CTXCollection, EDR, Calib
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# instruments.mro.hirise { #planetarypy.instruments.mro.hirise }
2+
3+
`instruments.mro.hirise`
4+

docs/reference/spice.archived_kernels.qmd

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,6 @@ Uses self.save_location if given, otherwise `planetarypy` archive.
102102
| --- | --- |
103103
| [download_one_url](#planetarypy.spice.archived_kernels.download_one_url) | Download a single URL to a local path. |
104104
| [get_metakernel_and_files](#planetarypy.spice.archived_kernels.get_metakernel_and_files) | For a given mission and start/stop times, download the kernels and get metakernel path. |
105-
| [is_start_valid](#planetarypy.spice.archived_kernels.is_start_valid) | Check if the start time is valid for a given mission. |
106-
| [is_stop_valid](#planetarypy.spice.archived_kernels.is_stop_valid) | Check if the stop time is valid for a given mission. |
107105
| [list_kernels_for_day](#planetarypy.spice.archived_kernels.list_kernels_for_day) | List all kernels for a given time range of a mission. |
108106

109107
### download_one_url { #planetarypy.spice.archived_kernels.download_one_url }
@@ -146,36 +144,6 @@ For a given mission and start/stop times, download the kernels and get metakerne
146144
| save_location | str | Overwrite default storing in planetarypy archive. Defaults to None. | `None` |
147145
| quiet | bool | Suppress download feedback. Defaults to False. | `False` |
148146

149-
### is_start_valid { #planetarypy.spice.archived_kernels.is_start_valid }
150-
151-
```python
152-
spice.archived_kernels.is_start_valid(mission, start)
153-
```
154-
155-
Check if the start time is valid for a given mission.
156-
157-
#### Parameters {.doc-section .doc-section-parameters}
158-
159-
| Name | Type | Description | Default |
160-
|---------|--------------|------------------------------------------------|------------|
161-
| mission | str | Mission shorthand label of datasets dataframe. | _required_ |
162-
| start | astropy.Time | Start time in astropy.Time format. | _required_ |
163-
164-
### is_stop_valid { #planetarypy.spice.archived_kernels.is_stop_valid }
165-
166-
```python
167-
spice.archived_kernels.is_stop_valid(mission, stop)
168-
```
169-
170-
Check if the stop time is valid for a given mission.
171-
172-
#### Parameters {.doc-section .doc-section-parameters}
173-
174-
| Name | Type | Description | Default |
175-
|---------|--------------|------------------------------------------------|------------|
176-
| mission | str | Mission shorthand label of datasets dataframe. | _required_ |
177-
| stop | astropy.Time | Stop time in astropy.Time format. | _required_ |
178-
179147
### list_kernels_for_day { #planetarypy.spice.archived_kernels.list_kernels_for_day }
180148

181149
```python

0 commit comments

Comments
 (0)