feat: properly include core component doc strings into Python docs #21
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
…olving "left-over" problems)
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.
This pull request includes several changes aimed at improving the documentation generation process and enhancing the logging and setup procedures for the Julia environment in the
iesoptpackage. The most important changes include updating the Julia package, enhancing documentation notes, and refining logging details.Documentation Improvements:
docs/dynamic/core.py: Updated the documentation generation script to ensure the latest version of theIESoptpackage is used and improved the clarity of the header notes. Deprecated functions for transforming markdown tables and details were commented out. All internal information are now included!Configuration Updates:
src/iesopt/config.py: Updated the default version ofIESOPT_COREfrom2.0.1to2.0.2.Logging Enhancements:
src/iesopt/julia/general.py: Enhanced the logging message to include the loaded versions of Python and Julia packages.src/iesopt/julia/setup.py: Added detailed logging for the Julia setup process, including the target directory, executable path, and project path. [1] [2] [3]src/iesopt/julia/util.py: Simplified the logging message for importing Julia modules.