Make required folder structure more flexible #108
Conversation
- writing of imports + component code (write python file) - component - fct map for generation - building list of components
- first section is home section recording it's compents - needs to be treated separately
- add overview page for each section showing components in main section folder
- Section could be used everywhere, Subsection is not really necessary. If a Section has subsections, the logic changes. Else nothing changes.
- set based on report type, and this is set on init - avoid to pass on variable to all functions.
- same as for streamlit_report to prepare refactoring of components parsing.
- very similar to _combine_components in streamlit_report - imports has to be a list of list -> figure this out - added debug message for skipping components in static reports-> should maybe be a warining?
|
Next would be to go even deeper and collect subfolder components to the subsection reports. This should be possible only in |
There was a problem hiding this comment.
In general, it works as expected, but there are some unintended behaviours:
- In a streamlit report, if there is a
description.mdfile for the report and there are components in the main folder, the description is shown twice. - In the streamlit report, instead of putting all the components from the main folder in the Home page, would not be better to create an ´Overview´ section, and keep the home section just for the title, description, and a graphical abstract if available?
- The revelajs' report structure is broken, I attached screenshots with the stable version and the one from this branch. Each subsection should be a tab in the section.
Stable version
Flexible folder str version
| section.file_path = subsection_file_path | ||
| # Create a Page object for each subsection and add it to the home page content | ||
| report_manag_content.append( | ||
| f"{section_name_var}_overview = st.Page('{subsection_file_path}', title='Overview {section.title}')" |
There was a problem hiding this comment.
Maybe the title can be just Overview to avoid repetition bc it's always under the section.title
There was a problem hiding this comment.
I think the title='Overview {section.title}' is even ignored. The subsection need unique names. So you cannot have just overview anywhere. I think the title is set based on the variable name.
|
Did you create your own example for revealjs? I think we are also still missing to update the basic example or just have a copy of the basic example with more complicated folder structure somewhere for testing. |
|
I think I will need to add |
|
I used the basic case study folder and created my own example; in both cases, the revealjs structure was not good. So, what would be the alternative to create just one qmd file? |
- I removed an empty f-string and this lead to doubled curely brackets...
|
Ok. It was a string interpolation issue. I removed a f-string which removed one level of the curly brackets before... Should be working now. I added tabs to the overview sections. |
⚠️ duplicated code - description files are parsed by configuration_manager - skipped for section content. So a section can have content, which is not used - a single description.md file
|
Before we add this, I would still adapt the basic example to include some components on the section folders and maybe even root of the example. But for the root, we maybe should have an even simpler example |
|
I noted done the additional testing requirments for a future PR in #116 |
allow components in all folders currently in examples
streamlit
quarto reports