This repository is test documentary holder for https://github.com/MeshInspector/MeshLib
Doxygen version 1.11 is used to generate documentation. The parameters not specified in the configurations correspond to the default values for this version.
- Install Doxygen 1.11 (via a package manager or after downloading from https://www.doxygen.nl/download.html)
- Install sed (usually pre-installed on Unix(-like) systems, Windows version is available at https://gnuwin32.sourceforge.net/packages/sed.htm)
- Download MeshLib and documentation rerepositories
cd workdir
git clone https://github.com/MeshInspector/MeshLib.git
git clone --recurse-submodules https://github.com/MeshInspector/MeshInspector.github.io.git- Getting python stub-files (for python documentation update) It's not critically important for generation and can be skipped in test (local) generation 1.a From meshlib python package 1.b Manual geneartion Use this manual https://github.com/MeshInspector/MeshLib/blob/master/scripts/mrbind/README.md
- Getting C bindings
It's not critically important for generation and can be skipped in test (local) generation
2.a From meshlib package
2.b Manual generation
Same as generation python stubs, but with arguments
TARGET=c -B --trace - Build documentation You can build release, dev, or local version of documentation. To do this, change target_folder to "MeshLib", "MeshLib/dev" or "MeshLib/local". Default target_folder is "MeshLib/local"
cd MeshInspector.github.io
./scripts/update_doc.sh target_folderFor manual generation see script ./scripts/update_doc.sh 3. Commit and push changes to this repository Note! Dont recommend push changes in MeshLib/dev folder because this folder will be updated after commit in master branch or after build PR with tag update-doc in MeshLib repository 4. Check out the results at https://meshinspector.github.io/*target_folder*/html/
- Run python http server
python3 -m http.server 8000- Open in browser http://127.0.0.1:8000/MeshLib/dev/html, http://127.0.0.1:8000/MeshLib/dev/html or http://127.0.0.1:8000/MeshLib/local/html (according target_folder) Note! http://127.0.0.1:8000 will be redirected to https://meshlib.io/documentation
Some parts of the documentation generation are sensitive to the doxygen version When updating the doxygen version, you need to check and update the following files if necessary:
- ./html_header.html
- ./html_footer.html You can try updating them using the following instructions:
- Prepare html_header.html
Inject Google Analytics code into the HTML header
sed -e "/<head>/r scripts/analytics/html_head.html" -e "/<body>/r scripts/analytics/html_body.html" -i html_header.html
Add doxygen-awesome scripts
sed -e "/<\/head>/q" html_header.html > html_header.html.tmp
sed -e "/<\/head>/d" -i html_header.html.tmp
cat scripts/doxygen-awesome-scripts.html >> html_header.html.tmp
sed -n -e "/<\/head>/,$ p" html_header.html >> html_header.html.tmp
rm html_header.html
mv html_header.html.tmp html_header.html
- Prepare html_footer.html
Set nofollow tag in footer
sed -i "s|href=|rel=\"nofollow\" href=|g" html_footer.html
Fix doxygen link in footer
sed -i "s|doxygen.org|doxygen.nl|g" html_footer.html