Skip to content

Preliminary work on installation/doc overhaul - #128

Merged
asher-m merged 9 commits into
masterfrom
dev/dev-merge
Sep 3, 2026
Merged

asher-m merged 9 commits into
masterfrom
dev/dev-merge

Conversation

@asher-m

@asher-m asher-m commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

This PR encapsulates a lot of preliminary work on overhauling the installation tooling and doc overhaul, including, but not limited to:

  • formatting-rules.md
    • We may wish to rename this to FORMATTING-RULES.md, which would be more standard for an instruction-type file
  • Migrating setup.py to pyproject.toml
  • Fixing numerous (but not all) Python docstring and Sphinx/ReST doc problems
  • Generating API docs via Sphinx autosummary
    • I.e., for all members that have docstrings
    • Members without docstrings remain undocumented (by Sphinx default behavior; we can change this if desired)

asher-m added 8 commits July 3, 2026 12:10
* and associated doc changes
* minimizing maintenance footprint
* no need to keep multiple sources on package versions up-to-date anymore
* executed by myst_nb at doc build
* also fix links in notebooks
* remove old API reference; include PCE formalism in new top-level heading
* autosummary'd items now leaving lots of errors and warnings about bad docstrings
  * have to fix later; this commit is already huge
* dunno what it does
* docs build fine without it
@asher-m
asher-m requested a review from akilnarayan September 3, 2026 18:36
@asher-m

asher-m commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator Author

Alas, I believe (without having deeply investigated at this point) that tests are failing because I forgot to update the Github Actions workflows. This may be a quick fix—we can take a look at this in our meeting shortly.

@asher-m asher-m left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified with Akil--sign off when you're happy.

@akilnarayan akilnarayan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirming approval

@asher-m
asher-m merged commit 0594744 into master Sep 3, 2026
5 of 14 checks passed
@asher-m
asher-m deleted the dev/dev-merge branch September 3, 2026 20:23
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.

2 participants