This library is the C++ version of the Python Triangle library. It is used for the Doxygen documentation tutorial specifically.
We asked Sphinx to use Doxygen to create the documentations, as if the documentations were generated by Sphinx, followed by hosting the documentations on Read the Docs.
.
├── CMakeLists.txt
├── docs
│ ├── doxygen
│ │ └── Doxyfile
│ ├── README.md
│ └── sphinx
│ ├── make.bat
│ ├── Makefile
│ └── source
│ ├── conf.py
│ ├── index.rst
│ ├── _static
│ └── _templates
├── examples
│ ├── area
│ │ ├── area.cpp
│ │ └── CMakeLists.txt
│ ├── CMakeLists.txt
│ └── README.md
├── include
│ └── triangle.h
├── LICENSE.md
├── README.md
├── requirements.txt
├── src
│ ├── CMakeLists.txt
│ ├── triangle.cpp
│ └── utils.cpp
└── tests
The trianglelib
used for the tutorial has no dependency. To install the Doxygen dependencies, please run the following command in the terminal.
$ sudo apt-get update
$ sudo apt-get install -y doxygen graphviz
To install the Python dependencies, please run the following command in the terminal.
$ pip install -r requirements.txt
To build the trianglelib
, please run the following command in the terminal.
$ mkdir -p build
$ cd build
$ cmake ..
$ make -j
Please check the README
in docs
for details.
Go to Read the Docs and follow the instructions to publish the documentations. The latest version of the documentation of this repo could be found on TriangleLib's Documentation. Use GitHub tags for version control on Read the Docs.