Subsubdirectories are required

[enryH]

I tested vuegen on one of my projects and I noticed that the folder structure does not allow the following layout.

report_folder
├── section1
│    ├── picture1.png
│    ├── picture2.png
├── section2
│    ├── picture1.png
│    ├── picture2.png

but instead requires

report_folder
├── section1
│   └── subsection
│       ├── picture1.png
│       ├── picture2.png
├── section2
│   └── subsection
│       ├── picture1.png
│       ├── picture2.png

I find this a bit confusing and see no clear reason why this should be the case. Is there any documentation on the restriction on the folder structure?

[enryH]

And on top of that the subsubfolders cannot have the same name for streamlit, which is also confusing.

[sayalaruano]

Hey! Yes, those are two limitations I also identified when doing the basic demo example. We discussed it also with @albsantosdel before, and I did not change the section-subsection directory structure because it would require modifying the class definitions for section and subsection. Now, A section is composed of subsections, and subsections have components.

But, it's true that always creating subsections is not ideal and confusing. There can be cases where just sections are needed. Should we make the changes to make sections also have components?

Regarding the folder naming on streamlit, maybe we can create an identifier for every file/folder, so we can allow sections/subsections with the same name?

[enryH]

That subsubsections should be non-unique is quite necessary. Otherwise you read an error like if you run things with more than one setting to compare:

StreamlitAPIException: Multiple Pages specified with URL pathname strainname. URL pathnames must be unique. The url pathname may be inferred from the filename, callable name, or title.

Traceback:
File "/Users/folder/streamlit_report/sections/report_manager.py", line 26, in <module>
    report_nav = st.navigation(sections_pages)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

[enryH]

And what would happen with subsubsub folders?

[sayalaruano]

For streamlit, it would not work, and for the quarto-based reports, it would be fine.

[enryH]

but then subsubsub folder should be made subsubfolders for the report, no?