Commit 97e5b293 authored by Peter Hutterer's avatar Peter Hutterer
Browse files

doc: add sphinx docs



This just the most basic scaffolding and build script to hook up to gitlab
pages. Actual docs need to be added.

The build script is a minimal wrapper around the sphinx-build command but this
way we can easily ensure that local rebuilding of the docs produces the same
output that gitlab pages will display.
Signed-off-by: Peter Hutterer's avatarPeter Hutterer <peter.hutterer@who-t.net>
parent c5f5047b
......@@ -87,6 +87,7 @@ stages:
- fedora_check
- ubuntu_container_build
- ubuntu_check
- pages
#
......@@ -136,6 +137,16 @@ check commits:
reports:
junit: results.xml
pages:
extends: .pip_install
stage: pages
script:
- pip3 install sphinx sphinx-rtd-theme
- bash -x doc/build-docs.sh
- mv build/html public
artifacts:
paths:
- public
bootstrap:
extends: .bootstrap
......
#!/bin/bash
SPHINXOPTS=
SPHINXBUILD=sphinx-build
SOURCEDIR=doc
BUILDDIR=build
if [[ ! -e "$SOURCEDIR/conf.py" ]]; then
echo "Please run me from the repository's base directory"
exit 1
fi
sphinx-build -M html "$SOURCEDIR" "$BUILDDIR" $SPHINXOPTS
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'ci-templates'
copyright = '2020'
author = 'see the git log for author information'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# 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']
ci-templates - templates for Gitlab CI pipelines
================================================
This repository contains a set of templates and documentation on how to
efficiently use the Gitlab CI on freedesktop.org.
.. toctree::
:maxdepth: 2
:caption: Contents:
templates
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`
.. _templates:
.gitlab-ci.yaml Templates
=========================
The CI templates are a set of Gitlab CI jobs that can be integrated into
your ``.gitlab-ci.yml`` file. The goal of the templates is to simplify
building and re-using container images for the project's registry.
.. _templates_building_containers:
Building container images
-------------------------
.. _templates_deleting_containers:
Deleting container images
-------------------------
......@@ -31,6 +31,7 @@ stages:
- {{ distribution }}_container_build
- {{ distribution }}_check
{% endfor %}
- pages
#
......@@ -80,6 +81,16 @@ check commits:
reports:
junit: results.xml
pages:
extends: .pip_install
stage: pages
script:
- pip3 install sphinx sphinx-rtd-theme
- bash -x doc/build-docs.sh
- mv build/html public
artifacts:
paths:
- public
bootstrap:
extends: .bootstrap
......
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