mirror of
https://github.com/cp2k/cp2k.git
synced 2026-07-29 06:35:28 -04:00
Docs: Reduce footprint of development section in navbar (#5521)
This commit is contained in:
parent
3c90c97729
commit
6d9f5ac9a2
5 changed files with 28 additions and 25 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
16
docs/development/under-the-hood.md
Normal file
16
docs/development/under-the-hood.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# Under the Hood
|
||||
|
||||
```{toctree}
|
||||
---
|
||||
titlesonly:
|
||||
maxdepth: 2
|
||||
---
|
||||
code-structure
|
||||
code-formatting
|
||||
coding-conventions
|
||||
error-handling
|
||||
print-keys
|
||||
preprocessing
|
||||
regtesting
|
||||
dependencies
|
||||
```
|
||||
|
|
@ -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}
|
||||
---
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue