This library is the C++ version of the Python Triangle library. It is used for the Sphinx C++ documentation tutorial specifically. The code used in this repository is almost the same to the code used in the Doxygen CPP TriangleLib repository, except that the Sphinx configuration file is different and it has an additional dependency on Breathe.
Doxygen will generate the required XML files that contains all the documentation content. Sphinx will use the XML files and the reStructuredText files the user provided to generate Sphinx documentations. The documentations will be hosted on Read the Docs.
.
├── CMakeLists.txt
├── docs
│ ├── doxygen
│ │ └── Doxyfile
│ ├── README.md
│ └── sphinx
│ ├── make.bat
│ ├── Makefile
│ └── source
│ ├── api.rst
│ ├── 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
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.