Skip to content

Conversation

@lwasser
Copy link
Member

@lwasser lwasser commented Nov 5, 2025

closes #127

Fixes:

  • sphinx design and other extensions not installing properly
  • Updates docs to fix a few bugs with build (Related to deps)
  • use autoapi in docs vs autodoc for simpler config
  • Merge the release workflow so build and release happen in one place with different triggers.
  • A few typos and bugs throughout

@lwasser
Copy link
Member Author

lwasser commented Nov 5, 2025

I hadn't noticed it was actually trying to publish on every commit - so i fixed that

@lwasser
Copy link
Member Author

lwasser commented Nov 5, 2025

I had fixed the documents and somehow not committed the changes. So this fixes those bugs and issues, so the docs build with clean and simple api docs (using autoapi for simplicity).m

# point AutoAPI at your package sources; adjust if using src layout
autoapi_dirs = ["../src"]
# Don't let AutoAPI automatically insert a toctree (avoid duplicates)
autoapi_add_toctree = False
Copy link
Member Author

Choose a reason for hiding this comment

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

Autoapi magically creates documentation. It' just a really nice, easy starting place. and we can redirect people to autodoc if they want more custom builds -- maybe the scientific Python guide covers that?

@lwasser lwasser merged commit 31815f4 into pyOpenSci:main Nov 5, 2025
6 checks passed
@lwasser lwasser deleted the ci2 branch November 5, 2025 21:33
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.

Enh: merge release and publish workflows for a simpler deployment process

1 participant