Code Monkey home page Code Monkey logo

doxygen-cpp-trianglelib's Introduction

Doxygen C++ TriangleLib

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.

Files

.
├── 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

Installation

Install Dependencies

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

Build TriangleLib

To build the trianglelib, please run the following command in the terminal.

$ mkdir -p build
$ cd build
$ cmake ..
$ make -j

Build Documentations

Please check the README in docs for details.

Publish Documentations

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.

References

doxygen-cpp-trianglelib's People

Contributors

leimao avatar

Stargazers

 avatar Yinda XU avatar  avatar Josh Mckeown avatar Louisliu avatar Zain  avatar Arslan Ali avatar grantseltzer avatar Satyam Tiwary avatar Cyril Grelier avatar Ramsey avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.