Skip to content
Snippets Groups Projects
Commit 5cedd91b authored by Bienchen's avatar Bienchen
Browse files

Documentation on make targets

parent 0d85eb06
No related branches found
No related tags found
No related merge requests found
...@@ -54,8 +54,18 @@ directory to get to a clean state again. No searching for |cmake| cache files or ...@@ -54,8 +54,18 @@ directory to get to a clean state again. No searching for |cmake| cache files or
checking if certain files really got rebuild and similar things required. checking if certain files really got rebuild and similar things required.
.. Important Make Targets Important Make Targets
.. ------------------------------------------------------------------------------- --------------------------------------------------------------------------------
Beside the usual ``make all`` and other default targets, there are a few
special targets:
* ``check`` Runs unit tests and if |cmake| was invoked in its standard
configuration also |sphinx| with the ``doctest`` and ``linkcheck`` builders
* ``html`` Creates documentation as web page using the |sphinx| ``html`` builder
* ``man`` Creates a manual page using the |sphinx| ``man`` builder
* ``doc`` Creates documentation using the ``html`` and ``man`` targets
* ``help`` Prints a list of targets available
.. _ost_l: http://www.OpenStructure.org .. _ost_l: http://www.OpenStructure.org
.. _ost_s: http://www.OpenStructure.org .. _ost_s: http://www.OpenStructure.org
...@@ -64,4 +74,5 @@ checking if certain files really got rebuild and similar things required. ...@@ -64,4 +74,5 @@ checking if certain files really got rebuild and similar things required.
.. _boost: http://www.boost.org/ .. _boost: http://www.boost.org/
.. _sphinx: http://sphinx-doc.org/ .. _sphinx: http://sphinx-doc.org/
.. LocalWords: cmake makefiles CMakeLists txt DOCTEST LINKCHECK conf .. LocalWords: cmake makefiles CMakeLists txt DOCTEST LINKCHECK conf html
.. LocalWords: doctest linkcheck
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment