Skeleton
This is the mandatory index.md
file that is the homepage of the documentation.
Here the documentation string of a function is expanded:
Skeleton.dummy_project_function
— Functiondummy_project_function(x, y) → z
Dummy function for illustration purposes. Performs operation:
\[z = x + y\]
Skeleton.fakesim
— Functionfakesim(x, y) → z
Fake simulation function for illustration purposes. Performs operation:
\[z = x + y\]
We can link to any subsection name with Subsection name.
We can link to documentation strings with dummy_project_function
.
Subsection name
Test.