Closed
Description
This issue tracks PyDPF-Core issues related to improvements made to the PyDPF-Core documentation
Documentation system
How should we organize the documentation website?
Sections
General #1762
Getting started
User guide
First proposition (#1763 )
After some reviews we got to make some changes :
- Change the tutorials approach (we were giving api reference we want a step by step guide)
- Make the solvers types more explicit
- Make the tutorials titles more "action/feature centered"
Second proposition (#1779 )
After some reviews we got to make some changes :
- make a simple preview of the tutorials in the user guide page
- tutorials new layout
Third proposition (#1876 ) (Final one)
After some reviews we got to make some changes :
- Put tutorials section before the concepts
- In the basics one -> don't limit DPF to a post processing tool
- Add a file with the links and references Add a links and refs file to be used in the doc #1940
Examples
- Add new subsections in the side bar changes in the sidebar of the examples section #1752
- Reorganize where each example is -> kinda doing this with the tutorials rearrangement
API Reference
- Reconfigure the side bar
- New designs for the cover page of this section adapt to the autoapi extension from ansys sphinx theme #1755
Operators
Concepts
- Merge with the user guide section (Move the concepts section into the User Guide #1819 )
Contribute
- move it to the the getting started page move contributing section into the getting started section #1829
- add tutorials guidelines Add tutorials guidelines in the main tutorials branch #1950