This GitLab instance will be migrated to gitlab.mel.vin before 2020-06-01 and will lose the shared runners, setup your own runners if needed.

Commit 035a58f0 authored by Stefan Schrijvers's avatar Stefan Schrijvers

Merge branch '108-improve-quickstart-building-help' into 'master'

Resolve "Improve quickstart/building help"

Closes #108

See merge request !91
parents 1068cf00 733d8914
......@@ -122,4 +122,3 @@ else()
COMMAND ;
COMMENT "Output at ${DOC_DEST}")
endif()
......@@ -4,6 +4,7 @@ API by source file name
`Return to the main documentation index. <../../index.html>`_
.. toctree::
:caption: Index
:glob:
*
......@@ -4,6 +4,7 @@ Continuous integration
Below is a list of extra information about the CI process.
.. toctree::
:caption: Index
:glob:
*
CMake options
=============
CMake build system
==================
Below is a list of all possible options that can be configured in CMake. Their
effect on the build and integrations with other options is also described.
.. toctree::
:caption: Index
:glob:
*
In case you haven't used CMake before, there are three tools to configure:
* ``cmake``
......@@ -13,7 +19,20 @@ In case you haven't used CMake before, there are three tools to configure:
* ``cmake-gui``
* Qt interface, can see the options and select them
.. toctree::
:glob:
Typically an interactive interface is used, unless CMake is being used in a
script or similar automated style. Below example uses ``ccmake`` in a Unix-like
environment. Using ``cmake-gui`` is also possible, no command line is needed in
that case.
*
.. code-block:: console
# the current directory must be the root of the repo
mkdir build
cd build
# configure, set desired options, configure and generate
ccmake ..
# from here on it depends on the generator used
# below example is for the "Unix Makefiles" generator
make help
......@@ -5,6 +5,7 @@ Documentation is deployed to both GitLab pages and a web host which accepts
``rsync`` to securely transfer data.
.. toctree::
:caption: Index
:glob:
*
......@@ -5,6 +5,7 @@ Sphinx is used for building documentation. The format used for the source files
is reStructuredText, usually abbreviated to RST.
.. toctree::
:caption: Index
:glob:
*
......
......@@ -6,6 +6,7 @@ your compilation and test environment in a way not dependant on the CI server
configuration.
.. toctree::
:caption: Index
:glob:
*
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment