From 84b0fd3f5bad65fc520a6acf8d9dfe11c15fea50 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Tue, 18 Sep 2018 21:33:21 +0200 Subject: [PATCH] chapter 12 abstracts --- chapter-12/recipe-01/README.md | 7 ++++++- chapter-12/recipe-01/abstract.md | 5 +++++ chapter-12/recipe-02/README.md | 7 ++++++- chapter-12/recipe-02/abstract.md | 5 +++++ chapter-12/recipe-03/README.md | 6 +++++- chapter-12/recipe-03/abstract.md | 4 ++++ 6 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 chapter-12/recipe-01/abstract.md create mode 100644 chapter-12/recipe-02/abstract.md create mode 100644 chapter-12/recipe-03/abstract.md diff --git a/chapter-12/recipe-01/README.md b/chapter-12/recipe-01/README.md index 0bc6ef5fa..354e2bf13 100644 --- a/chapter-12/recipe-01/README.md +++ b/chapter-12/recipe-01/README.md @@ -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/) diff --git a/chapter-12/recipe-01/abstract.md b/chapter-12/recipe-01/abstract.md new file mode 100644 index 000000000..ae4939bc6 --- /dev/null +++ b/chapter-12/recipe-01/abstract.md @@ -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. diff --git a/chapter-12/recipe-02/README.md b/chapter-12/recipe-02/README.md index 50f384ca0..236e8c85c 100644 --- a/chapter-12/recipe-02/README.md +++ b/chapter-12/recipe-02/README.md @@ -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/) diff --git a/chapter-12/recipe-02/abstract.md b/chapter-12/recipe-02/abstract.md new file mode 100644 index 000000000..1bcd83677 --- /dev/null +++ b/chapter-12/recipe-02/abstract.md @@ -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. diff --git a/chapter-12/recipe-03/README.md b/chapter-12/recipe-03/README.md index de5554c03..311e1d832 100644 --- a/chapter-12/recipe-03/README.md +++ b/chapter-12/recipe-03/README.md @@ -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/) diff --git a/chapter-12/recipe-03/abstract.md b/chapter-12/recipe-03/abstract.md new file mode 100644 index 000000000..1ca4ae2e1 --- /dev/null +++ b/chapter-12/recipe-03/abstract.md @@ -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).