forked from dev-cafe/cmake-cookbook
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
31 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,10 @@ | ||
# Building documentation using Doxygen | ||
|
||
Abstract to be written ... | ||
[Doxygen](http://www.doxygen.nl) is a popular source code documentation tool in | ||
the C++ community. Running Doxygen will extract comments which contain | ||
documentation tags and create the documentation in a format defined in the | ||
Doxyfile configuration file (HTML, XML, and even LaTeX or PDF). This recipe | ||
shows how to use CMake to build your Doxygen documentation. | ||
|
||
|
||
- [cxx-example](cxx-example/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
[Doxygen](http://www.doxygen.nl) is a popular source code documentation tool in | ||
the C++ community. Running Doxygen will extract comments which contain | ||
documentation tags and create the documentation in a format defined in the | ||
Doxyfile configuration file (HTML, XML, and even LaTeX or PDF). This recipe | ||
shows how to use CMake to build your Doxygen documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,10 @@ | ||
# Building documentation using Sphinx | ||
|
||
Abstract to be written ... | ||
[Sphinx](http://www.sphinx-doc.org) can parse reStructuredText, Markdown | ||
plain-text files, and generate HTML, ePUB, or PDF documentation. Coupled with the | ||
online [Read the Docs](https://readthedocs.org) service, it offers a great way to quickly | ||
get started with writing and deploying documentation. This recipe shows how to | ||
use CMake to build documentation based on Sphinx. | ||
|
||
|
||
- [cxx-example](cxx-example/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
[Sphinx](http://www.sphinx-doc.org) can parse reStructuredText, Markdown | ||
plain-text files, and generate HTML, ePUB, or PDF documentation. Coupled with the | ||
online [Read the Docs](https://readthedocs.org) service, it offers a great way to quickly | ||
get started with writing and deploying documentation. This recipe shows how to | ||
use CMake to build documentation based on Sphinx. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,9 @@ | ||
# Combining Doxygen and Sphinx | ||
|
||
Abstract to be written ... | ||
This recipe illustrates | ||
how to use the [Breathe](https://breathe.readthedocs.io) plugin in combination with CMake | ||
to bridge [Doxygen](http://www.doxygen.nl) and | ||
[Sphinx](http://www.sphinx-doc.org). | ||
|
||
|
||
- [cxx-example](cxx-example/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
This recipe illustrates | ||
how to use the [Breathe](https://breathe.readthedocs.io) plugin in combination with CMake | ||
to bridge [Doxygen](http://www.doxygen.nl) and | ||
[Sphinx](http://www.sphinx-doc.org). |