Skip to content

Conversation

ischeider
Copy link
Contributor

Description and Context

This PR introduces the new layout for the reference sections. The basic layout has been provided by @gilrrei (thanks!), now they are integrated into the documentation. The new style is very informative which unfortunately means that the reference documentation becomes very large and complex. Hence, the built-up of the page was very slow, and I split the reference documentation in different chapters.

As of now we have:

  • Cell types (was already available previously)
  • Spatial discretization
  • Material information
  • Boundary conditions
  • general parameters

The differentiation is done by simple string search, which is done in the routine create_markdown_documentation within https://github.com/ischeider/4C/blob/17ef391e65c36254bf9ed350a1bdf68bb1c23430/utilities/four_c_python/src/four_c_documentation/make_documentation.py . Particularly, please check whether we should use a different mechanism or split the chapters differently.

In addition, this PR removes large parts of create_rtd. Only the resources for the cell type definitions are still contained in this tool. If anybody knows how to get the information about node, line and face numbering of the different elements in a different way, we can dump the whole tool (but deleting this information is not the solution IMO).

@ischeider ischeider force-pushed the refactor_referencedoc branch from f5115a2 to a174987 Compare October 9, 2025 12:51
@ischeider
Copy link
Contributor Author

One additional comment:

A particular feature introduced here is the listing of all test files that contain a particular section (which by default is collapsed) - thanks again, @gilrrei .
However, some section are used so often that I think a listing is not useful (e.g., SOLVER 1 or MATERIALS). Therefore, in make_documentation.py I introduced a constant TOO_MANY_TESTS_TO_SHOW, which is set to 200 by now. Any discussion whether this is meaningful is welcome.

Copy link
Member

@sebproell sebproell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool! I downloaded the new docs and had a look. I believe this PR is in good shape to be merged as this is much better than what we had before. We can always improve the styling or behavior of certain sections, but it is good to get the new infrastructure in place. Many thanks @ischeider @gilrrei!

Copy link
Contributor

@gilrrei gilrrei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making my script mess usable 😅 I think this is already a great improvement 🎆

I think for some reason the FUNCT section is missing 🤔 (edit: my bad)

@ischeider ischeider force-pushed the refactor_referencedoc branch 2 times, most recently from b057df6 to 2627e81 Compare October 9, 2025 16:43
@ischeider
Copy link
Contributor Author

This commit contains all the reviewer comments (thanks @gilrrei @sebproell !) except a little formatting and the FUNCT stuff (don't know yet how to include this less hacky)

sebproell
sebproell previously approved these changes Oct 9, 2025
amgebauer
amgebauer previously approved these changes Oct 10, 2025
@ischeider ischeider dismissed stale reviews from amgebauer and sebproell via c0de10c October 10, 2025 09:43
@ischeider
Copy link
Contributor Author

I also added the description for the reference chapters. Please have a look.

sebproell
sebproell previously approved these changes Oct 13, 2025
gilrrei
gilrrei previously approved these changes Oct 13, 2025
@ischeider ischeider dismissed stale reviews from gilrrei and sebproell via f412bf5 October 13, 2025 13:14
@ischeider ischeider force-pushed the refactor_referencedoc branch from c0de10c to f412bf5 Compare October 13, 2025 13:14
@ischeider
Copy link
Contributor Author

Resolved the merge conflict, and added the comment about MATERIALS by @sebproell above.

Add special treatment of FUNCT, file descriptions
@ischeider ischeider force-pushed the refactor_referencedoc branch from f412bf5 to 65b6125 Compare October 13, 2025 13:18
Copy link
Contributor

@gilrrei gilrrei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A diff of 900 lines, so nice

@ischeider ischeider enabled auto-merge October 13, 2025 13:30
@ischeider ischeider merged commit 0d9cc33 into 4C-multiphysics:main Oct 13, 2025
51 of 53 checks passed
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.

4 participants