Skip to content

MAINT: Merge update_docs branch#48

Merged
derb12 merged 13 commits intodevelopmentfrom
update_docs
Sep 14, 2025
Merged

MAINT: Merge update_docs branch#48
derb12 merged 13 commits intodevelopmentfrom
update_docs

Conversation

@derb12
Copy link
Copy Markdown
Owner

@derb12 derb12 commented Sep 14, 2025

Description

  • Updated the documentation theme to pydata-sphinx-theme, which overall looks nicer.
  • Added a CI job for running doctests, with the idea being that each baseline correction method should eventually have an example or two, showing basic usage and any noteworthy features, which are tested to ensure the code runs as expected. Alongside adding these examples, it would be nice to update most docstrings with details concerning what each algorithm actually does, similar to what the algorithms section of the docs currently do, rather than just stating their names...
    • As an initial endeavor, added examples and additional information to the docstrings for asls, iasls, airpls, and arpls.

Since updating most docstrings is going to be a rather disruptive change, it'd be easier to merge this branch into development now and gradually update each method's docstring alongside other work so that I don't have to go through a merge conflict nightmare later.

Type of Pull Request

  • Bug Fix
  • New Feature
  • Miscellaneous Changes (refactor, code improvements, etc.)
  • Documentation or Example Programs

Pull Request Checklist

  • New code and/or documentation is valid for use with the BSD 3-clause license.
  • New code is fully documented with docstrings that follow Numpy style, if applicable.
  • New code follows PEP 8 standards as closely as possible, if applicable.
  • Added/updated tests and ensured they pass locally, if applicable.
  • Verified that documentation builds locally, if applicable.

derb12 added 13 commits August 31, 2025 12:15
New blue looks better in dark mode. logo_plot now also generates the full logo rather than just the curve.
Will be used for examples in both docs and docstrings
Matplotlib's plot directive will now show code by default in order to work with docstring examples. As a result, have to manually hide code when desired in the docs.
Added scipy-doctest as a testing dependency since without it doctests fail because of matplotlib's plotting outputs
Updated the docstrings and added examples for asls, iasls, airpls, and arpls.
@derb12
Copy link
Copy Markdown
Owner Author

derb12 commented Sep 14, 2025

Can ignore the failure on the nightly job, that's from my own deprecations that I can address after merging.

@derb12 derb12 merged commit b9e4fde into development Sep 14, 2025
11 of 12 checks passed
@derb12 derb12 deleted the update_docs branch September 14, 2025 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant