Skip to content

feat: src packaging, pre-commits, and automated docs#52

Merged
Soap2G merged 6 commits into
mainfrom
guerrie-docstrings
Aug 28, 2025
Merged

feat: src packaging, pre-commits, and automated docs#52
Soap2G merged 6 commits into
mainfrom
guerrie-docstrings

Conversation

@Soap2G
Copy link
Copy Markdown
Contributor

@Soap2G Soap2G commented Aug 28, 2025

Closes #34
Closes #39
Closes #45

Major:

  • atlasopenmagic now is packaged as src/atlasopenmagic; shouldn't change anything from the practical point of view
  • Pre commits are now added for an easy way of checking of what we are doing makes sense. Please have a look to the criteria and let me know if we shouldn't be so picky.
  • Documentation for the Python APIs are now automatically generated and pushed to our main website. Will create an MR also down there to account for this. (see atlas-open-data-website-v2!134 that needs to be merged first!)

Minor:

@Soap2G Soap2G requested review from marianaiv and zlmarshall August 28, 2025 10:43
@Soap2G Soap2G self-assigned this Aug 28, 2025
@Soap2G Soap2G added the enhancement New feature or request label Aug 28, 2025
@Soap2G Soap2G force-pushed the guerrie-docstrings branch from e987353 to 87cd903 Compare August 28, 2025 10:47
Copy link
Copy Markdown
Contributor

@zlmarshall zlmarshall left a comment

Choose a reason for hiding this comment

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

This is awesome. Thank you! Just a small handful of questions and comments.

Comment thread src/atlasopenmagic/metadata.py
Comment thread src/atlasopenmagic/__init__.py
Comment thread .pre-commit-config.yaml Outdated
Comment thread pyproject.toml
Comment thread .pre-commit-config.yaml
Comment thread .github/workflows/pre-commit.yml Outdated
@Soap2G Soap2G force-pushed the guerrie-docstrings branch from 38d28d6 to f45d07b Compare August 28, 2025 12:58
Copy link
Copy Markdown
Contributor

@zlmarshall zlmarshall left a comment

Choose a reason for hiding this comment

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

Ok, I'm happy. Thanks again!

@Soap2G Soap2G merged commit de90085 into main Aug 28, 2025
6 checks passed
@Soap2G Soap2G deleted the guerrie-docstrings branch August 28, 2025 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automate functions documentation Adding pre-commit (with code checkers) Use src packaging layout

2 participants