diff options
| author | Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> | 2021-05-03 14:14:21 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-03 14:14:21 +0200 |
| commit | a6d8eed666d168d4bf38789024b92b5af081c85d (patch) | |
| tree | c49623f53bfec2ce8215637e1eecc5fa7cd704c8 /.github | |
| parent | 70387c34b638972b7c51017b81949f32ddd63e39 (diff) | |
| parent | e90121bf0c62de00e0d10548f833632f3dfdf799 (diff) | |
Merge pull request #484 from VincentRouvreau/doxygen_improvement
Doxygen documentation improvement
Diffstat (limited to '.github')
| -rw-r--r-- | .github/for_maintainers/new_gudhi_version_creation.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/.github/for_maintainers/new_gudhi_version_creation.md b/.github/for_maintainers/new_gudhi_version_creation.md index aadfae7d..d6c4cdd3 100644 --- a/.github/for_maintainers/new_gudhi_version_creation.md +++ b/.github/for_maintainers/new_gudhi_version_creation.md @@ -34,16 +34,21 @@ make -j 4 all && ctest -j 4 --output-on-failure ## Create the documentation ```bash mkdir gudhi.doc.@GUDHI_VERSION@ -make doxygen 2>&1 | tee dox.log && grep warning dox.log ``` ***[Check there are no error and the warnings]*** ```bash -cp -R gudhi.@GUDHI_VERSION@/doc/html gudhi.doc.@GUDHI_VERSION@/cpp cd gudhi.@GUDHI_VERSION@ rm -rf build; mkdir build; cd build cmake -DCMAKE_BUILD_TYPE=Release -DCGAL_DIR=/your/path/to/CGAL -DWITH_GUDHI_EXAMPLE=ON -DPython_ADDITIONAL_VERSIONS=3 .. +make doxygen 2>&1 | tee dox.log && grep warning dox.log +``` + +***[Check there are no error and the warnings]*** + +```bash +cp -R html ../../gudhi.doc.@GUDHI_VERSION@/cpp export LC_ALL=en_US.UTF-8 # cf. bug https://github.com/GUDHI/gudhi-devel/issues/111 make sphinx ``` |