-
Notifications
You must be signed in to change notification settings - Fork 0
🚧 start to explore adding subsections to homesection #125
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
Conversation
enryH
commented
Jun 16, 2025
- probably best to assume that a single section with with no-subsection is a valid homepage
- maybe try to explore if setting a title should lead to a different behaviour
- use the homepage layout as it was before: title, descrpiton, logo and graphical abstract - if there are components in the main folder, trigger to add section with main folder name if the configuration is built using the directory based method. - a new section with the components is added - if configs are created manually, the first section is treated as every other section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tested it with the apicall and chatbot cong files and it works as expected.
I also tested the HTML and revelajs formats using the basic case study config example, and there are some problems. If we define subsections in the first section, they are omitted, maybe bc on the quarto-based reports we are still reserving the first section for the components without a subsection. We should try to test it further and fix the quarto_report.py file to follow the same structure as the streamlit one.
|
In the basic example an empty home-section is created, I will have to double check if this intended |
- move html report file to correct place: update rel. paths - add others as of now
- do not use description as component in main folder - the description is added to the key description
- do not treat first section special - add example of how to run this config - check in cdci workflow
I added the test for
|
- update tests - make altair plot path relative to qmd file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR explores adding subsections to the home section and refactors report generation logic for both Streamlit and Quarto outputs, updates the CI workflow to validate protected example outputs, and regenerates test example files for multiple report formats.
- Refactor homepage generation in Streamlit and Quarto views to treat the main section uniformly
- Enhance
config_managerto include main-directory components and skip empty description files - Add CI checks in
.github/workflows/cdci.ymlto prevent unintended changes in example reports
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/vuegen/streamlit_reportview.py | Refactored homepage generation and section-loop logic |
| src/vuegen/quarto_reportview.py | Removed main-section overview block and simplified section loops |
| src/vuegen/config_manager.py | Treat main directory as a section, skip description.md files |
| .github/workflows/cdci.yml | Added CI jobs to protect generated report examples |
| tests/report_examples/Basic_example_vuegen_demo_notebook_*/ | Regenerated example QMD files for all formats |
Comments suppressed due to low confidence (4)
src/vuegen/quarto_reportview.py:131
- Remove or resolve this leftover question/comment and the large commented-out block to improve code clarity.
self._generate_image_content(self.report.graphical_abstract)
src/vuegen/streamlit_reportview.py:158
- Remove this stray TODO comment; production code shouldn't include implementation notes.
# ! move this into the _generate_home_section method
src/vuegen/streamlit_reportview.py:159
- This assignment is immediately overwritten and never used—consider removing it.
subsection_page_vars = []
src/vuegen/config_manager.py:347
- Remove this debug print statement to avoid logging to stdout in library code.
print(f"Found file in main section directory: {section_dir.name}")
…ultiomics-Analytics-Group/report_generator into fix_empty_report_w_one_section
…te execution section of README