Skip to content
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

Optimize sdist Build Size and Improve Documentation #11

Merged
merged 11 commits into from
Jan 31, 2024

Conversation

mdapena
Copy link
Owner

@mdapena mdapena commented Jan 31, 2024

Initial Checks

  • The code compiles successfully without any errors or warnings.
  • I have personally tested these changes on my local environment.
  • I have ensured that relevant documentation has been added or updated.
  • I adhere to the project structure and code standards defined in the documentation.
  • My code follows the established coding style guidelines.
  • I have added tests for the new code (if applicable).
  • All existing tests have passed successfully.

Description

This PR focuses on optimizing the sdist build size and improving the documentation.

  • Optimized the size of the sdist build by including only essential files and directories, such as /src, /tests, .gitignore, pyproject.toml, CITATION.cff, README.md, and LICENSE.
  • Refactored the dependencies of the docs environment by separating them into an optional dependency called docs.
  • Updated the deploy-docs.yml GitHub workflow to utilize the new docs optional dependency.
  • Updated the EventEmission class with the @final decorator from the typing module, indicating that it is meant for internal use only and should not be subclassed.
  • Addressed minor errors and fixed broken links in the documentation.

@mdapena mdapena added enhancement Suggests an improvement or enhancement to an existing feature documentation Improvements or additions to documentation github actions Pull requests that update Github actions code labels Jan 31, 2024
@mdapena mdapena self-assigned this Jan 31, 2024
@mdapena mdapena merged commit 3956ed4 into master Jan 31, 2024
11 checks passed
@mdapena mdapena deleted the sdist-size-optimization branch January 31, 2024 03:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Suggests an improvement or enhancement to an existing feature github actions Pull requests that update Github actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant