Merge #146

146: Add type hierarchy to docs, misc doc fixes r=charleskawczynski a=charleskawczynski

This PR adds some type hierarchy to the docs

Co-authored-by: Charles Kawczynski <[email protected]>

Author: bors[bot]

README.md

@@ -7,14 +7,14 @@
 | **GHA CI**           | [![gha ci][gha-ci-img]][gha-ci-url]           |
 | **Code Coverage**    | [![codecov][codecov-img]][codecov-url]        |
 
-[docs-bld-img]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/docs.yml/badge.svg
-[docs-bld-url]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/docs.yml
+[docs-bld-img]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/Documentation.yml/badge.svg
+[docs-bld-url]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/Documentation.yml
 
 [docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
 [docs-dev-url]: https://CliMA.github.io/ClimaTimeSteppers.jl/dev/
 
-[gha-ci-img]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/ci.yml/badge.svg
-[gha-ci-url]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/ci.yml
+[gha-ci-img]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/UnitTests.yml/badge.svg
+[gha-ci-url]: https://github.com/CliMA/ClimaTimeSteppers.jl/actions/workflows/UnitTests.yml
 
 [codecov-img]: https://codecov.io/gh/CliMA/ClimaTimeSteppers.jl/branch/main/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/CliMA/ClimaTimeSteppers.jl

docs/src/dev/report_gen.md

@@ -1,6 +1,6 @@
-# Algorithm comparisons
+# Report generator
 
-In this section, we compare the solution errors and convergence orders for several test problems and algorithms.
+In this section, we create a report comparing the solution errors and convergence orders for several test problems and algorithms.
 
 ```@example
 include("report_gen.jl")

docs/src/dev/types.md

@@ -2,4 +2,22 @@
 
 In this section, we print out the type hierarchies of some classes via code snippets.
 
-TODO: fill out
+## Algorithms
+
+```@example
+import AbstractTrees as AT
+import InteractiveUtils as IU
+import ClimaTimeSteppers as CTS
+AT.children(x::Type) = IU.subtypes(x)
+AT.print_tree(CTS.DistributedODEAlgorithm)
+```
+
+## Tableaus
+
+```@example
+import AbstractTrees as AT
+import InteractiveUtils as IU
+import ClimaTimeSteppers as CTS
+AT.children(x::Type) = IU.subtypes(x)
+AT.print_tree(CTS.AbstractTableau)
+```