...
 
Commits (10)
......@@ -5,6 +5,10 @@ Reverse chronologically sorted, i.e. newest on top.
For details view the associated milestone of a release which are linked below.
View the commit history for minor fixes and improvements.
## 1.9.1 / 2018-07-27
https://git.mel.vin/template/c/milestones/16
## 1.9.0 / 2018-07-22
https://git.mel.vin/template/c/milestones/15
......
......@@ -23,7 +23,7 @@ endif()
unset(PROJECT_LANGUAGES)
project(doc_template
VERSION 1.9.0
VERSION 1.9.1
DESCRIPTION "__DESCRIPTION__"
LANGUAGES ${PROJECT_LANGUAGES})
set(PROJECT_VERSION_SUFFIX "") # alpha/beta/rc, e.g. "-rc0"
......
......@@ -43,10 +43,6 @@ configure_file(
"${DOC_SRC}/conf.py.in"
"${DOC_TMP}/sphinx/conf.py"
@ONLY)
configure_file(
"${DOC_SRC}/_static/theme_overrides.css.in"
"${DOC_TMP}/sphinx/_static/theme_overrides.css"
COPYONLY)
add_custom_target(doc ALL
COMMAND "${CMAKE_COMMAND}" -E echo
......
......@@ -13,10 +13,15 @@ effect on the build and integrations with other options is also described.
In case you haven't used CMake before, there are three tools to configure:
* ``cmake``
* command-line interface, have to specify all options at once
* ``ccmake``
* curses interface, can see the options and select them
* ``cmake-gui``
* Qt interface, can see the options and select them
Typically an interactive interface is used, unless CMake is being used in a
......
line_limit
==========
.. note:: Requires a Unix-like environment.
.. note::
Requires a Unix-like environment.
When configuring with ``-DLINE_LIMIT:BOOL=ON`` target ``line_limit`` will be
added. The target will invoke the ``line_limit.sh`` script.
......
regex_check
===========
.. note:: Requires a Unix-like environment.
.. note::
Requires a Unix-like environment.
When configuring with ``-DREGEX_CHECK:BOOL=ON`` target ``regex_check`` will be
added. The target will invoke the ``regex_check.sh`` script.
......
......@@ -84,6 +84,9 @@ pygments_style = 'sphinx'
# documents using the standard reST default-role directive.
default_role = 'any'
# The default language to highlight source code.
highlight_language = 'rst'
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
......@@ -103,7 +106,7 @@ if '@DOC@' == 'html':
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ['@DOC_SRC@/_static']
# Fix table line wrapping for RTD theme
# https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
......
......@@ -2,6 +2,7 @@ Per-branch documentation review
===============================
.. note::
The templates uses the shared host ``doc.mel.vin`` which is for internal
use only. You need a webserver with ``rsync`` (secure) or some other
way to upload and delete things from a CI job like ``ftp`` (insecure).
......
Version
=======
.. note:: If there is no root commit yet git will emit a fatal error.
.. note::
If there is no root commit yet git will emit a fatal error.
Based upon the current state of the git repository CMake automatically updates
the version number with details. The format is
......
Managing docker images
======================
.. note:: Requires a Unix-like environment.
.. note::
Requires a Unix-like environment.
Helper script
-------------
......@@ -35,6 +37,7 @@ Version management
~~~~~~~~~~~~~~~~~~
.. note::
When two branches would need to edit the exact same docker image they
will overwrite each other on push. This is a limitation of the way
docker images are managed with this "version control". For most use
......