Skip to content
Snippets Groups Projects
Commit 3434c4f3 authored by Stéphane Del Pino's avatar Stéphane Del Pino
Browse files

Add missing dependency on gmsh for user doc generation

parent 937c5bae
No related branches found
No related tags found
No related merge requests found
...@@ -706,6 +706,12 @@ else() ...@@ -706,6 +706,12 @@ else()
message(" gnuplot: not found!") message(" gnuplot: not found!")
endif() endif()
if (GMSH)
message(" gmsh: ${GMSH}")
else()
message(" gmsh: not found!")
endif()
if (PYGMENTIZE) if (PYGMENTIZE)
message(" pygmentize: ${PYGMENTIZE}") message(" pygmentize: ${PYGMENTIZE}")
else() else()
...@@ -718,7 +724,7 @@ else() ...@@ -718,7 +724,7 @@ else()
message(" pdflatex: not found!") message(" pdflatex: not found!")
endif() endif()
if (NOT EMACS OR NOT GNUPLOT_FOUND) if (NOT EMACS OR NOT GNUPLOT_FOUND OR NOT GMSH)
message(" ** Cannot build documentation: missing ") message(" ** Cannot build documentation: missing ")
elseif(NOT LATEX_PDFLATEX_FOUND OR NOT PYGMENTIZE) elseif(NOT LATEX_PDFLATEX_FOUND OR NOT PYGMENTIZE)
message(" ** Cannot build pdf documentation: missing") message(" ** Cannot build pdf documentation: missing")
...@@ -729,6 +735,9 @@ endif() ...@@ -729,6 +735,9 @@ endif()
if (NOT GNUPLOT_FOUND) if (NOT GNUPLOT_FOUND)
message(" - gnuplot") message(" - gnuplot")
endif() endif()
if (NOT GMSH)
message(" - gmsh")
endif()
if (NOT LATEX_PDFLATEX_FOUND) if (NOT LATEX_PDFLATEX_FOUND)
message(" - pdflatex") message(" - pdflatex")
endif() endif()
......
...@@ -86,7 +86,7 @@ apt install slepc-dev ...@@ -86,7 +86,7 @@ apt install slepc-dev
### User documentation ### User documentation
To build documentation one requires `emacs` and `gnuplot`, To build documentation one requires `emacs`, `gmsh` and `gnuplot`,
additionally since examples results are generated, the documentation additionally since examples results are generated, the documentation
can only be produced after the compilation of `pugs` itself. can only be produced after the compilation of `pugs` itself.
...@@ -94,6 +94,10 @@ To install `emacs` on Debian-like systems ...@@ -94,6 +94,10 @@ To install `emacs` on Debian-like systems
```shell ```shell
apt install emacs apt install emacs
``` ```
To install `gmsh` on Debian-like systems
```shell
apt install gmsh
```
To install `gnuplot` one can either use To install `gnuplot` one can either use
```shell ```shell
apt install gnuplot-nox apt install gnuplot-nox
...@@ -106,6 +110,7 @@ apt install gnuplot-x11 ...@@ -106,6 +110,7 @@ apt install gnuplot-x11
> When building the documentation for the first time, a local `emacs` > When building the documentation for the first time, a local `emacs`
> configuration is generated. *This requires an internet connection.* > configuration is generated. *This requires an internet connection.*
These packages are enough to build the html documentation. To build These packages are enough to build the html documentation. To build
the pdf documentation one requires a few more packages: `pdflatex` the pdf documentation one requires a few more packages: `pdflatex`
(actually a fresh texlive installation is probably necessary) and `pygmentize` (actually a fresh texlive installation is probably necessary) and `pygmentize`
......
...@@ -12,10 +12,13 @@ find_program(PYGMENTIZE pygmentize) ...@@ -12,10 +12,13 @@ find_program(PYGMENTIZE pygmentize)
# check for gnuplot # check for gnuplot
find_package(Gnuplot) find_package(Gnuplot)
# check for gmsh
find_program(GMSH NAMES gmsh)
add_custom_target(userdoc) add_custom_target(userdoc)
add_custom_target(doc DEPENDS userdoc) add_custom_target(doc DEPENDS userdoc)
if (EMACS AND GNUPLOT_FOUND) if (EMACS AND GNUPLOT_FOUND AND GMSH)
add_custom_command( add_custom_command(
OUTPUT "${PUGS_BINARY_DIR}/doc" OUTPUT "${PUGS_BINARY_DIR}/doc"
...@@ -129,6 +132,13 @@ else() ...@@ -129,6 +132,13 @@ else()
COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red --bold "gnuplot missing") COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red --bold "gnuplot missing")
add_dependencies(userdoc userdoc-missing-gnuplot) add_dependencies(userdoc userdoc-missing-gnuplot)
endif() endif()
if (NOT GMSH)
add_custom_target(userdoc-missing-gmsh
COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --no-newline "Cannot build documentation: "
COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red --bold "gmsh missing")
add_dependencies(userdoc userdoc-missing-gmsh)
endif()
endif() endif()
add_dependencies(doc userdoc) add_dependencies(doc userdoc)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment