Documentation facelift #275
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #275 +/- ##
==========================================
+ Coverage 89.52% 89.57% +0.04%
==========================================
Files 17 17
Lines 1795 1803 +8
==========================================
+ Hits 1607 1615 +8
Misses 188 188 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
not sure if it fits in this PR or a future one, but we have a lot of example docs implemented within docstrings in various parts of the code (i am one of the guilty parties). as part of a fuller refactor, we should decide whether to leave that as-is, migrate it to specific |
hpparvi
force-pushed
the
documentation_facelift
branch
from
7ee2d16 to
c7344e7
Compare
|
The documentation update is coming together! Please take a look at the rendered docs at No need to worry about the large number of commits and changed files. This PR builds on the 1D wavelength calibration PR, which should be merged first. |
hpparvi
requested review from
camipacifici,
cshanahan1,
kecnry and
tepickering
- Added `sphinx-copybutton` and `sphinx-design` to documentation dependencies in `pyproject.toml`. - Improved content structure by renaming and reorganizing documentation files. - Expanded "Contributing" and "Index" sections.
…action examples; updated `conf.py` with formatting adjustments and extended Sphinx documentation settings.
- Corrected typos and clarified text. - Renamed `common.py` to `quickstart.py`. - Updated function and variable names for consistency. - Streamlined background subtraction and wavelength calibration workflows.
…uncertainty handling.
…tdDevUncertainty` when absent.
…doc_xref_param_type` configuration.
hpparvi
force-pushed
the
documentation_facelift
branch
from
c6a96b5 to
d4d0c76
Compare
2 participants
This PR modernizes the documentation by adopting
sphinx_astropy.conf.v2with thepydata-sphinx-theme. It also updates and reorganizes several existing sections and introduces new documentation covering 1D wavelength calibration.