diff options
| author | Claudius "keldu" Holeksa <mail@keldu.de> | 2024-07-04 15:15:32 +0200 |
|---|---|---|
| committer | Claudius "keldu" Holeksa <mail@keldu.de> | 2024-07-04 15:15:32 +0200 |
| commit | 596964ba245e17444baa196c16b4531c03f7a4b2 (patch) | |
| tree | 397626b0bf1fe3c6007a7214d5a40ee9b9c3866f | |
| parent | ff5535b51730974b7933dd93e140579f3232a275 (diff) | |
Example for the docs
| -rw-r--r-- | docs/source/core/introduction.rst | 4 | ||||
| -rw-r--r-- | docs/source/index.rst | 11 |
2 files changed, 13 insertions, 2 deletions
diff --git a/docs/source/core/introduction.rst b/docs/source/core/introduction.rst new file mode 100644 index 0000000..0c436d3 --- /dev/null +++ b/docs/source/core/introduction.rst @@ -0,0 +1,4 @@ +Introduction +============ + +The core represents the most essential parts of this code base. diff --git a/docs/source/index.rst b/docs/source/index.rst index b994f13..7de2907 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Gasp Example's documentation! -======================================== +Welcome to forstio's documentation! +=================================== .. toctree:: :hidden: @@ -16,6 +16,13 @@ Welcome to Gasp Example's documentation! .. toctree:: :hidden: :maxdepth: 2 + :caption: Core + + core/introduction + +.. toctree:: + :hidden: + :maxdepth: 2 :caption: API Reference c_api/index |