Skip to content

Conversation

@enryH
Copy link
Collaborator

@enryH 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

@sayalaruano sayalaruano linked an issue Jun 17, 2025 that may be closed by this pull request
enryH added 3 commits June 17, 2025 11:30
- 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
@enryH enryH marked this pull request as ready for review June 17, 2025 10:48
@enryH enryH requested a review from sayalaruano June 17, 2025 10:48
Copy link
Collaborator

@sayalaruano sayalaruano left a 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.

@enryH
Copy link
Collaborator Author

enryH commented Jun 21, 2025

In the basic example an empty home-section is created, I will have to double check if this intended

@enryH
Copy link
Collaborator Author

enryH commented Jun 24, 2025

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.

I added the test for html using the specified configuration file basic case study config example. I will add the streamlit-based one once we fix the setting of relative paths in streamlit (which I will do on a separate PR). but otherwise it should work.

  • I get locally some error with showing .svg from GitHub, but png work from url sources.

@enryH enryH requested review from Copilot and sayalaruano June 24, 2025 19:55
Copy link

Copilot AI left a 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_manager to include main-directory components and skip empty description files
  • Add CI checks in .github/workflows/cdci.yml to 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}")

@enryH enryH merged commit 6d29572 into main Jun 25, 2025
14 checks passed
@enryH enryH deleted the fix_empty_report_w_one_section branch June 25, 2025 09:30
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.

Empty Streamlit report when passing a config with one section

3 participants