Commit 0cff7623 authored by Mathias Chouet's avatar Mathias Chouet 🍝
Browse files

Update README for PDF doc

parent 3c1f2a5f
......@@ -9,13 +9,21 @@ See also [developers documentation](DEVELOPERS.md) (in french)
* [jalhyd](https://gitlab.irstea.fr/cassiopee/jalhyd)
* npm
* python3
* pandoc (optional, for PDF documentation only)
* texlive (optional, for PDF documentation only)
Building the documentation requires MkDocs and some extensions:
Building the HTML documentation requires MkDocs and some extensions:
```sh
sudo apt install python3-pip python3-setuptools
python3 -m pip install mkdocs python-markdown-math mkdocs-material
```
Building the PDF documentation requires pandoc and a LaTeX distribution (for ex. texlive) with a few packages:
```sh
sudo apt install pandoc texlive-base texlive-bibtex-extra texlive-binaries texlive-font-utils texlive-fonts-recommended texlive-lang-french texlive-latex-base texlive-latex-extra texlive-latex-recommended texlive-pictures
```
### Install dependencies
......@@ -35,6 +43,7 @@ Then in `nghyd` folder, run :
npm install
```
### Compile and get a deployable Web app
```sh
......@@ -42,6 +51,13 @@ npm run build
```
### Compile and get a deployable Web app (without PDF doc)
Use this if you don't want to install LaTeX dependencies.
```sh
npm run build-no-pdf
```
### Compile in dev (watch) mode
```sh
......@@ -178,15 +194,12 @@ npm run mkdocs
```
### Create PDF documentation from HTML documentation
### Generate PDF documentation
```sh
sudo apt-get install texlive texlive-lang-french texlive-latex-extra pandoc
npm run mkdocs2pdf
```
```sh
python3 mkdocs2pdf.py
```
### Generate compodoc
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment