diff --git a/docs/development/code-formatting.md b/docs/development/code-formatting.md index aaba4c9832..2cf295a7a1 100644 --- a/docs/development/code-formatting.md +++ b/docs/development/code-formatting.md @@ -1,4 +1,4 @@ -# Code Formatting Conventions and Prettify Tool +# Code Formatting Uniform formatting of CP2K source code is enabled by a [fprettify](https://github.com/fortran-lang/fprettify) that is an almost complete auto-formatter for diff --git a/docs/development/code-structure.md b/docs/development/code-structure.md index 54f0b3bee8..52b4be4553 100644 --- a/docs/development/code-structure.md +++ b/docs/development/code-structure.md @@ -1,4 +1,4 @@ -# CP2K Code Structure +# Code Structure CP2K is a large, complex application which has many features, methods and algorithms implemented. When looking at the code for the first time it can be very challenging to understand how it all diff --git a/docs/development/regtesting.md b/docs/development/regtesting.md index a873df259f..50dda53175 100644 --- a/docs/development/regtesting.md +++ b/docs/development/regtesting.md @@ -1,4 +1,4 @@ -# CP2K Regression Testing +# Regression Testing CP2K comes with over 3000 test input files (located in \[[src>tests]\]) which serve as both examples on how to use the many features in CP2K and also as a method for developers to test modifications diff --git a/docs/development/under-the-hood.md b/docs/development/under-the-hood.md new file mode 100644 index 0000000000..64b01a674a --- /dev/null +++ b/docs/development/under-the-hood.md @@ -0,0 +1,16 @@ +# Under the Hood + +```{toctree} +--- +titlesonly: +maxdepth: 2 +--- +code-structure +code-formatting +coding-conventions +error-handling +print-keys +preprocessing +regtesting +dependencies +``` diff --git a/docs/index.md b/docs/index.md index 132d7f6727..d6d2bbba69 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,8 +8,6 @@ class: no-scaled-link --- ``` -% TODO: `{toctree} % :caption: Get started % % get-started/installation % get-started/tutorials % ` - ```{toctree} --- caption: Getting Started @@ -23,23 +21,6 @@ getting-started/distributions getting-started/first-calculation ``` -```{toctree} ---- -caption: Development -titlesonly: -maxdepth: 1 ---- -development/onboarding -development/coding-conventions -development/code-structure -development/error-handling -development/print-keys -development/code-formatting -development/regtesting -development/preprocessing -development/dependencies -``` - ```{toctree} --- caption: Methods @@ -69,8 +50,6 @@ technologies/accelerators/index technologies/libraries ``` -% TODO: `{toctree} % :caption: How-to guides % % dummy % ` - ```{toctree} --- caption: References @@ -83,7 +62,15 @@ acronyms units ``` -% TODO: `{toctree} % :caption: Explanations % % dummy % ` +```{toctree} +--- +caption: Development +titlesonly: +maxdepth: 1 +--- +development/onboarding +development/under-the-hood +``` ```{toctree} ---