README.md 1.21 KB
Newer Older
1
# User documentation
David Hrbáč's avatar
David Hrbáč committed
2

David Hrbáč's avatar
David Hrbáč committed
3 4 5 6 7 8 9 10 11 12 13 14
This project contains IT4Innovations user documentation source.

## Development

### Install

```console
$ sudo apt install libpython-dev
$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed
15

David Hrbáč's avatar
David Hrbáč committed
16
## Environments
David Hrbáč's avatar
David Hrbáč committed
17

18 19
* [https://docs.it4i.cz - master branch](https://docs.it4i.cz - master branch)
* [https://docs.it4i.cz/devel/$BRANCH_NAME](https://docs.it4i.cz/devel/$BRANCH_NAME) - maps the branches, available only with VPN access
David Hrbáč's avatar
David Hrbáč committed
20

David Hrbáč's avatar
David Hrbáč committed
21 22
## URLs

Lukáš Krupčík's avatar
Lukáš Krupčík committed
23 24
* [http://facelessuser.github.io/pymdown-extensions/](http://facelessuser.github.io/pymdown-extensions/)
* [http://squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/)
David Hrbáč's avatar
David Hrbáč committed
25 26 27 28 29 30 31 32

```
fair-share
InfiniBand
RedHat
CentOS
Mellanox
```
David Hrbáč's avatar
David Hrbáč committed
33

David Hrbáč's avatar
David Hrbáč committed
34
## Mathematical Formulae
David Hrbáč's avatar
David Hrbáč committed
35

Lukáš Krupčík's avatar
Lukáš Krupčík committed
36
### Formulas are made with:
David Hrbáč's avatar
David Hrbáč committed
37

Pavel Gajdušek's avatar
Pavel Gajdušek committed
38 39
* [https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/](https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/)
* [https://www.mathjax.org/](https://www.mathjax.org/)
David Hrbáč's avatar
David Hrbáč committed
40 41 42 43 44 45 46 47 48 49

You can add formula to page like this:

```
$$
MAX\_FAIRSHARE * ( 1 - \frac{usage_{Project}}{usage_{Total}} )
$$
```

To enable the MathJX on page you need to enable it by adding line ```---8<--- "mathjax.md"``` at the end of file.