build,docs: add sphinx to CI

This commit is contained in:
Vicente Adolfo Bolea Sanchez 2023-10-20 14:31:40 -04:00
parent 7f400505c9
commit 181d5616eb
2 changed files with 23 additions and 16 deletions

@ -26,13 +26,18 @@ RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-ins
libtbb-dev \
mpich \
ninja-build \
python3-breathe \
python3-sphinx-rtd-theme \
python3-pip \
rsync \
software-properties-common \
sphinx-rtd-theme-common \
ssh
RUN python3 -m pip install \
breathe \
sphinx \
sphinxcontrib-moderncmakedomain \
sphinxcontrib-packages \
sphinx-rtd-theme
# Need to run git-lfs install manually on ubuntu based images when using the
# system packaged version
RUN git-lfs install

@ -1,6 +1,14 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
##=============================================================================
##
## Copyright (c) Kitware, Inc.
## All rights reserved.
## See LICENSE.txt for details.
##
## This software is distributed WITHOUT ANY WARRANTY; without even
## the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
## PURPOSE. See the above copyright notice for more information.
##
##=============================================================================
# Required
version: 2
@ -10,19 +18,13 @@ build:
os: ubuntu-22.04
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
configuration: docs/users-guide/conf.py
# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub
formats:
- pdf
- epub
# Optional but recommended, declare the Python requirements required
# to build your documentation