Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
nghyd
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Admin message
A compter du 1er avril, attention à vos pipelines :
Nouvelles limitations de Docker Hub
Show more breadcrumbs
Cassiopée
nghyd
Commits
0cff7623
Commit
0cff7623
authored
5 years ago
by
mathias.chouet
Browse files
Options
Downloads
Patches
Plain Diff
Update README for PDF doc
parent
3c1f2a5f
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!74
Resolve "Générer la documentation en PDF"
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+19
-6
19 additions, 6 deletions
README.md
with
19 additions
and
6 deletions
README.md
+
19
−
6
View file @
0cff7623
...
...
@@ -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
```
###
Cre
ate PDF documentation
from HTML documentation
###
Gener
ate PDF documentation
```
sh
sudo
apt-get
install
texlive texlive-lang-french texlive-latex-extra pandoc
npm run mkdocs2pdf
```
```
sh
python3 mkdocs2pdf.py
```
### Generate compodoc
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment