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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# Documentation
The documentation for LFortran is built with sphinx
## Installing dependencies
To build the documentation you will need the following dependencies
- [sphinx-build](https://www.sphinx-doc.org) for building the pages
- [sphinx-intl](https://www.sphinx-doc.org/en/master/usage/advanced/intl.html) for translations
- [sphinx-material](https://bashtage.github.io/sphinx-material/) for the page theme
- [sphinx-copybutton](https://sphinx-copybutton.readthedocs.io/en/latest/) to allow copying of code-blocks
- [myst-parser](https://myst-parser.readthedocs.io/en/latest/) for markdown support
- [nbsphinx](https://nbsphinx.readthedocs.io/en/latest/) for converting notebooks
- LFortran with jupyter kernel for the notebook conversion
You can install all required dependencies using the mamba package manager as
shown in the next section.
## Building the documentation
First create and load the Conda environment:
```console
cd doc
mamba env create -f environment.yml
conda activate lfortran_docs
```
To build the documentation run the `build.py` script:
```
python build.py
```
To view the rendered pages start a http server:
```
python -m http.server -d site
```
And go to: http://localhost:8000/en/
You can also pass the language as an argument to only build part of the site
```
python build.py en de
```
## Updating the documentation
To update the documentation edit the markdown files in the `doc/src` directory.
If you add new files in Markdown (`md`) or Notebook (`ipynb`) format, make sure to include them in a _toctree_ directive.
To update the translation files after an addition to the docs, run
```
python intl.py
```
New translations can be added in `doc/src/_static/languages.json`.
Make sure the default language (English) is always first.
## Translating the documentation
Translations can be contributed via [weblate](https://hosted.weblate.org/projects/fortran-lang/lfortran-docs/).
[](https://hosted.weblate.org/engage/fortran-lang/)
The documentation can also be translated by editing the _po_-files in `doc/locale`.
|
