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

Documentation, clean up, actions, etc. #8

Merged
merged 7 commits into from
Apr 2, 2024

Conversation

Thoemi09
Copy link
Contributor

This is a big PR with many but mostly trivial changes:

  • formatted .clang-tidy
  • added doxygen documentation to the C++ code and did some trivial clean up (renaming variables, adding [[nodiscard]], fixing include statements, etc.)
  • removed the zip_with function which was untested and not used anywhere else
  • split the large itertools.hpp into multiple small headers
  • added some tests and did some clean up
  • removed all sphinx related files from the doc folder and added doxygen files, removed cpp2py dependency
  • updated the ghactions workflow to build the documentation and deploy it

Note that some of the changes are rather subjective like splitting the larger header file and cleaning up the code. We can discuss if this is a good idea or if I should stick as much as possible to the existing code.

@Thoemi09 Thoemi09 force-pushed the DEV_DOCUMENTATION branch 2 times, most recently from d2cb796 to 45a5569 Compare March 22, 2024 12:54
@Thoemi09 Thoemi09 requested a review from Wentzell March 22, 2024 13:05
Copy link
Member

@Wentzell Wentzell left a comment

Choose a reason for hiding this comment

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

Thank you @Thoemi09 for this huge improvement!
Everything looks good now.

.github/workflows/build.yml Show resolved Hide resolved
@Wentzell Wentzell merged commit 3fe1c30 into TRIQS:unstable Apr 2, 2024
4 checks passed
@Thoemi09 Thoemi09 deleted the DEV_DOCUMENTATION branch April 4, 2024 12:36
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