1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
title: Documentation
# Documentation
## Build
To build the documentation you need [FORD](https://github.com/Fortran-FOSS-Programmers/ford).
Afterwards use the `doc` target for the CMake generated Makefile:
```bash
mkdir build
cd build
cmake .. # will look for the `ford` binary
make doc
```
Note that in order to generate the documentation with examples (recommended), the following options should be activated in cmake (these are the options' default values)
```bash
cmake -DUSE_MPI=ON -DWITH_EXAMPLES=ON .. # these options are default and recommended.
# If set off, the examples' documentation is not generated.
```
The documentation (HTML format) will be located in `doc/`. To view it, open `doc/index.html` in a browser.
## Add Pages
To add pages to the documentation, write Markdown files and add them to the desired location in `dbcsr/docs/guide`. Note that subfolders of `guide` will only be added to the documentation pages if they contain a file `index.md`. For more information on writing pages, see [Ford's documentation](https://github.com/Fortran-FOSS-Programmers/ford/wiki/Writing-Pages).
|
