-
Notifications
You must be signed in to change notification settings - Fork 53
Create new reference documentation layout #1368
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
Create new reference documentation layout #1368
Conversation
f5115a2
to
a174987
Compare
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 . |
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.
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!
doc/documentation/src/analysis_guide_templates/boundaryconditions.rst.j2
Show resolved
Hide resolved
utilities/four_c_python/src/four_c_documentation/make_documentation.py
Outdated
Show resolved
Hide resolved
utilities/four_c_python/src/four_c_documentation/make_documentation.py
Outdated
Show resolved
Hide resolved
utilities/four_c_python/src/four_c_documentation/make_documentation.py
Outdated
Show resolved
Hide resolved
utilities/four_c_python/src/four_c_documentation/make_documentation.py
Outdated
Show resolved
Hide resolved
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.
Thanks for making my script mess usable 😅 I think this is already a great improvement 🎆
I think for some reason the (edit: my bad)FUNCT
section is missing 🤔
utilities/four_c_python/src/four_c_documentation/make_documentation.py
Outdated
Show resolved
Hide resolved
utilities/four_c_python/src/four_c_documentation/make_documentation.py
Outdated
Show resolved
Hide resolved
b057df6
to
2627e81
Compare
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) |
I also added the description for the reference chapters. Please have a look. |
utilities/four_c_python/src/four_c_documentation/make_documentation.py
Outdated
Show resolved
Hide resolved
c0de10c
to
f412bf5
Compare
Resolved the merge conflict, and added the comment about MATERIALS by @sebproell above. |
Add special treatment of FUNCT, file descriptions
f412bf5
to
65b6125
Compare
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.
A diff of 900 lines, so nice
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:
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).