clean up docs

byuflowlab · Sep 26, 2024 · 441e0b2 · 441e0b2
1 parent 5c729d8
commit 441e0b2
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 12 deletions.
diff --git a/docs/src/DuctAPE/advanced_usage/outputs.md b/docs/src/DuctAPE/advanced_usage/outputs.md
@@ -1,5 +1,3 @@
-## Available Outputs
-
 The output tuple contains many items.
 The [`post_process`](@ref "DuctAPE.post_process") function docstring lists them.
 The purpose of showing this function here is not for you to manually run the fuction or apply any advanced usage, but simply rather for you to see what the available outputs are, as several of them may apply to advanced usage cases.

diff --git a/docs/src/DuctAPE/api/private_preprocess.md b/docs/src/DuctAPE/api/private_preprocess.md
@@ -1,3 +1,9 @@
+
+```@contents
+Pages = ["private_preprocess.md"]
+Depth = 5
+```
+
 ## General
 
 ```@docs

diff --git a/docs/src/DuctAPE/api/private_process.md b/docs/src/DuctAPE/api/private_process.md
@@ -1,24 +1,29 @@
+```@contents
+Pages = ["private_process.md"]
+Depth = 5
+```
+
 ## Analysis
 ```@docs
 DuctAPE.analyze_multipoint
 ```
 
-### Process
+## Process
 ```@docs
 DuctAPE.process
 DuctAPE.solve
 ```
 
-#### Solvers
-##### ModCSOR
+### Internal Solvers
+#### ModCSOR
 ```@docs
 DuctAPE.mod_COR_solver
 DuctAPE.relax_Gamr_mod!
 DuctAPE.relax_gamw_mod!
 DuctAPE.update_states!
 ```
 
-##### CSOR
+#### CSOR
 ```@docs
 DuctAPE.apply_relaxation_schedule
 DuctAPE.update_CSOR_residual_values!
@@ -27,29 +32,29 @@ DuctAPE.relax_Gamr!
 DuctAPE.relax_gamw!
 ```
 
-#### Residuals
+### Residuals
 
-##### ModCSOR
+#### ModCSOR
 ```@docs
 DuctAPE.mod_CSOR_residual!
 DuctAPE.estimate_CSOR_states!
 ```
 
-##### CSOR
+#### CSOR
 ```@docs
 DuctAPE.CSOR_residual!
 DuctAPE.compute_CSOR_residual!
 ```
 
-##### External Solvers
+#### External Solvers
 ```@docs
 DuctAPE.system_residual
 DuctAPE.system_residual!
 DuctAPE.update_system_residual!
 DuctAPE.estimate_states!
 ```
 
-#### Solve Utilities
+## Solve Utilities
 ```@docs
 DuctAPE.extract_initial_guess
 DuctAPE.extract_state_variables

diff --git a/docs/src/DuctAPE/api/private_utilities.md b/docs/src/DuctAPE/api/private_utilities.md
@@ -1,4 +1,3 @@
-## Utility Functions
 ```@docs
 DuctAPE.promote_ducted_rotor_type
 DuctAPE.isscalar