...
 
Commits (33)
......@@ -9,7 +9,7 @@ variables:
line_limit:
stage: analyse
allow_failure: true
image: git.mel.vin:5005/template/c/cicd/coreutils:1.1
image: git.mel.vin:5005/template/c/cicd/coreutils:1.2
script:
- mkdir build
- cd build
......@@ -19,7 +19,7 @@ line_limit:
regex_check:
stage: analyse
allow_failure: true
image: git.mel.vin:5005/template/c/cicd/coreutils:1.1
image: git.mel.vin:5005/template/c/cicd/coreutils:1.2
script:
- mkdir build
- cd build
......@@ -28,7 +28,7 @@ regex_check:
sphinx_html:
stage: test
image: git.mel.vin:5005/template/doc/cicd/sphinx_html:1.2
image: git.mel.vin:5005/template/doc/cicd/sphinx_html:1.3
script:
- mkdir build
- cd build
......@@ -46,7 +46,7 @@ review:
- branches@template/doc
dependencies:
- sphinx_html
image: git.mel.vin:5005/template/c/cicd/coreutils:1.1
image: git.mel.vin:5005/template/c/cicd/coreutils:1.2
environment:
name: review/$CI_COMMIT_REF_NAME
url: https://doc.mel.vin/template/doc/$CI_ENVIRONMENT_SLUG
......@@ -65,7 +65,7 @@ review_stop:
GIT_STRATEGY: none
when: manual
dependencies: []
image: git.mel.vin:5005/template/c/cicd/coreutils:1.1
image: git.mel.vin:5005/template/c/cicd/coreutils:1.2
environment:
name: review/$CI_COMMIT_REF_NAME
action: stop
......@@ -87,7 +87,7 @@ pages:
- tags@template/doc
dependencies:
- sphinx_html
image: git.mel.vin:5005/template/c/cicd/coreutils:1.1
image: git.mel.vin:5005/template/c/cicd/coreutils:1.2
script:
- mv build/doc/html public
artifacts:
......
......@@ -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.12.0 / 2019-04-28
https://git.mel.vin/template/c/milestones/19
## 1.11.0 / 2018-09-17
https://git.mel.vin/template/c/milestones/18
......
......@@ -23,7 +23,7 @@ endif()
unset(PROJECT_LANGUAGES)
project(doc_template
VERSION 1.11.0
VERSION 1.12.0
DESCRIPTION "__DESCRIPTION__"
LANGUAGES ${PROJECT_LANGUAGES})
set(PROJECT_VERSION_SUFFIX "") # alpha/beta/rc, e.g. "-rc0"
......
......@@ -37,7 +37,7 @@ The official project home and all official mirrors:
## Tips
* [spacevim](http://spacevim.org/)
* [conf/vim](https://git.mel.vin/conf/vim)
* the brilliant cult again creates the superior user experience
* [spacemacs](http://spacemacs.org/)
* the evil church can never escape from their bloated foundations
......
FROM alpine:latest
FROM debian:stretch
ADD bootstrap.sh /
RUN /bootstrap.sh && rm /bootstrap.sh
git.mel.vin:5005/template/c/cicd/coreutils:1.1
git.mel.vin:5005/template/c/cicd/coreutils:1.2
#!/bin/sh
DEBIAN=stretch
set -e
apk --no-cache add \
printf '%s\n' \
"deb http://ftp.debian.org/debian $DEBIAN-backports main" \
> /etc/apt/sources.list.d/$DEBIAN-backports.list
apt-get update
apt-get dist-upgrade -y
# backported cmake requires backported libuv1
apt-get install --no-install-recommends -y \
bash \
cmake \
ca-certificates \
cmake/$DEBIAN-backports \
coreutils \
findutils \
git \
grep \
libuv1/$DEBIAN-backports \
make \
openssh-client \
rsync \
sed
apt-get autoremove -y
apt-get clean
rm -rf /var/lib/apt/lists/*
FROM alpine:latest
FROM debian:stretch
ADD bootstrap.sh /
RUN /bootstrap.sh && rm /bootstrap.sh
git.mel.vin:5005/template/doc/cicd/sphinx_html:1.2
git.mel.vin:5005/template/doc/cicd/sphinx_html:1.3
#!/bin/sh
PLANTUML=1.2018.10
DEBIAN=stretch
PLANTUML=master
set -e
apk --no-cache add \
cmake \
font-noto \
printf '%s\n' \
"deb http://ftp.debian.org/debian $DEBIAN-backports main" \
> /etc/apt/sources.list.d/$DEBIAN-backports.list
apt-get update
apt-get dist-upgrade -y
# backported cmake requires backported libuv1
apt-get install --no-install-recommends -y \
ca-certificates \
cmake/$DEBIAN-backports \
curl \
default-jre-headless \
git \
graphviz \
libuv1/$DEBIAN-backports \
make \
openjdk8-jre \
py2-pip \
ttf-dejavu \
ttf-liberation
python3-pip \
python3-setuptools \
python3-wheel
apk --no-cache add -t tmp \
curl
# some font metapackages use recommends to install their subpackages
apt-get install -y \
fonts-dejavu \
fonts-liberation \
fonts-noto
ln -s /usr/bin/python3 /usr/local/bin/python
ln -s /usr/bin/pip3 /usr/local/bin/pip
pip install \
sphinx \
......@@ -38,4 +56,9 @@ printf '%s\n%s\n' \
> /usr/local/bin/plantuml
chmod +x /usr/local/bin/plantuml
apk --no-cache del tmp
apt-get purge -y \
curl
apt-get autoremove -y
apt-get clean
rm -rf /var/lib/apt/lists/*
......@@ -52,7 +52,23 @@ add_custom_target(doc ALL
-d "${DOC_TMP}/sphinx/doctrees" -j auto
-c "${DOC_TMP}/sphinx" -q ${SPHINX_WERROR}
"${DOC_SRC}" "${DOC_DEST}")
add_custom_command(TARGET doc POST_BUILD
COMMAND ;
COMMENT "Output at ${DOC_DEST}")
add_custom_target(doc_nocache
COMMAND "${CMAKE_COMMAND}" -E echo
"Generating sphinx ${DOC} documentation, no cache"
COMMAND "${CMAKE_COMMAND}" -E env "PYTHONPATH=${PYTHONPATH}"
"${PYTHON_EXECUTABLE}" -m sphinx -b "${DOC}" -E
-d "${DOC_TMP}/sphinx/doctrees" -j auto
-c "${DOC_TMP}/sphinx" -q ${SPHINX_WERROR}
"${DOC_SRC}" "${DOC_DEST}")
add_custom_command(TARGET doc_nocache POST_BUILD
COMMAND ;
COMMENT "Output at ${DOC_DEST}")
add_custom_target(doc_clean
COMMAND "${CMAKE_COMMAND}" -E remove_directory "${DOC_DEST}"
COMMAND "${CMAKE_COMMAND}" -E remove_directory
"${DOC_TMP}/sphinx/doctrees")
/* override table width restrictions */
@media screen and (min-width: 767px) {
.wy-table-responsive table td, .wy-table-responsive table th {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}
.wy-table-responsive {
overflow: visible !important;
}
.wy-table-responsive table td, .wy-table-responsive table th {
white-space: normal !important;
}
.wy-table-responsive {
overflow: visible !important;
}
}
......@@ -15,4 +15,12 @@ builder type ``${BUILDER}``.
When also configuring with ``-DWERROR:BOOL=ON`` all warnings generated by
``sphinx`` will be turned into errors.
By default ``sphinx`` caches both input and output files to speed things up.
Target ``doc_nocache`` will force reading all source files, this ensures dynamic
directives such as toctrees are updated properly while still caching things that
haven't changed properly.
Target ``doc_clean`` will also be added and removes build products and temporary
files related to the ``doc`` target itself.
Refer to http://www.sphinx-doc.org/en/master/builders.html for builder details.