-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Packaging fixes #245
Merged
Merged
Packaging fixes #245
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ocumentation warnings, add automodule documentation
…hould be fully available in source distribution
cehbrecht
approved these changes
Mar 18, 2024
Thanks for cleaning up birdy 🙂 Looks good 👍
I think a new release is worth it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Changes:
Manifest.in
changes)sphinx-apidoc
-based listing of all installed modules and functionssphinx-copybutton
andsphinx-codeautolink
in order to increase the usefulness of code-blocks in the example documentation (copying of code blocks and ability to click onbirdy
objects and go straight to the documentation entry for the object)birdy[extra]
pip install recipe to be able to install all extras needed more directlypandoc
(unmaintained)build
to build the documentation.Related Issue / Discussion
The changes here make it so that running the tests requires that the package is installed, as tests are no longer seen as part of the installed package. This reduces the size of the wheel significantly, while also making it so that source distributions have all the required files to run tests (good for
conda-forge
).Eventually, it would be good to migrate this package to
pyproject.toml
to simplify/centralize a lot of these configurations, but this is fine for now.Additional Information
@cehbrecht Would it make sense to perform another release after this? The changes are relatively significant to the packaging, but doesn't touch the core logic. Perhaps another patch release? I leave that decision up to you.