Hello, Breathe!

Generating functional Documentation For 'C/C++'s Sources

@Gitter :gitter.im/cnruby
Code ID: basic_120
Code Name: Hello, Breathe!

Youtube Video

TABLE of CONTENTS

• About The Project
  • Requirements
  • Install Breathe, Doxygen and Sphinx on MacOS
  • How does this Video Relate to the Other Videos?
• Generation 'Breathe's API Documentation
  • What is The Tool breathe
  • Get The Code with Shell Commands
  • Illustrate Generating 'Breathe's API Documentation
  • The Folder's Structure
  • Commands for The Illustratation
• Final Summary
• References

About The Project

Requirements

• VS Code 1.43.0+
• CMake 3.17.0+
• Python 3.7+
• Doxygen 1.8.17
• Graphviz 2.43.0+
• Sphinx 3.0.2
• Sphinx bootstrap theme
• Breathe 4.16.0+: Sphinx bridge to Doxygen
• VS Code Extension: reStructuredText

Install Breathe, Doxygen and Sphinx on MacOS

brew install doxygen
brew cask install graphviz
pip install sphinx sphinx-autobuild
brew install sphinx-doc
pip install sphinx_bootstrap_theme
pip install breathe

How does this Video Relate to the Other Videos?

Generation 'Breathe's API Documentation

What is The Tool breathe

Get The Code with Shell Commands

git clone https://github.com/cnruby/w3h1_cmake.git basic_120
cd basic_120
git checkout basic_120
code .

Illustrate Generating 'Breathe's API Documentation

The Folder's Structure

#<!-- markdown-exec(cmd:cat docs/output/tree.txt) -->#
.
├── api
│  ├── conf.py
│  ├── header.rst
│  ├── index.rst
│  ├── main.rst
│  └── requirements.txt
├── cmake
│  ├── CMakeLists.txt
│  ├── doxygen
│  │  └── CMakeLists.txt
│  ├── module
│  │  └── FindSphinx.cmake
│  └── sphinx
│     ├── CMakeLists.txt
│     └── conf.in.py
├── CMakeLists.txt
├── lib
│  ├── CMakeLists.txt
│  ├── header.cxx
│  └── header.hxx
└── src
   ├── CMakeLists.txt
   └── main.cxx
#<!-- /markdown-exec -->

Commands for The Illustratation

cmake -GNinja -Bbuild/
cmake --build build --target target_doxygen
cmake --build build --target target_sphinx
cmake --build build --target target_docs
open build-doc-doxygen/html/index.html
open build-doc-sphinx/_build/index.html

Final Summary

感谢大家观看!

@Gitter: gitter.im/cnruby

@Github: github.com/cnruby

@Twitter: twitter.com/cnruby

@Blogspot: cnruby.blogspot.com

References

• https://www.sphinx-doc.org/en/master/usage/installation.html
• https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/
• https://github.com/InsightSoftwareConsortium/ITKExamples/blob/master/CMake/FindSphinx.cmake
• https://eb2.co/blog/2012/03/sphinx-and-cmake-beautiful-documentation-for-c---projects/
• https://stackoverflow.com/questions/26464879/how-to-build-cmake-documentation-with-sphinx
• https://cmake.org/pipermail/cmake/2009-February/027365.html
• http://macappstore.org/doxygen/
• http://www.doxygen.nl/
• http://macappstore.org/doxygen/
• http://macappstore.org/graphviz-2/
• http://graphviz.org/
• https://stackoverflow.com/questions/24488250/check-graphviz-installed-version-on-ubuntu
• https://github.com/TartanLlama/cpp-documentation-example
• https://www.sphinx-doc.org/en/master/usage/quickstart.html
• https://github.com/akheron/jansson/blob/master/cmake/FindSphinx.cmake
• https://github.com/InsightSoftwareConsortium/ITKExamples/blob/master/CMake/FindSphinx.cmake
• https://gitlab.cern.ch/dss/eos/blob/1fda896069c59c8ab414770363a6bee94e4ad013/cmake/FindSphinx.cmake
• https://raw.githubusercontent.com/llvm-mirror/llvm/master/cmake/modules/FindSphinx.cmake
• https://ceres-solver.googlesource.com/ceres-solver/+/refs/tags/1.12.0rc4/CMakeLists.txt
• https://ceres-solver.googlesource.com/ceres-solver/+/refs/tags/1.12.0rc4/cmake/FindSphinx.cmake
• https://stackoverflow.com/questions/47553569/how-can-i-build-multiple-targets-using-cmake-build?rq=1
• https://github.com/michaeljones/breathe
• https://breathe.readthedocs.io/en/latest/index.html