vtk-m/.readthedocs.yaml

44 lines
1.2 KiB
YAML
Raw Permalink Normal View History

2023-10-20 18:31:40 +00:00
##=============================================================================
##
## 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.
##
##=============================================================================
2023-10-20 18:13:51 +00:00
# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
2023-10-20 22:10:48 +00:00
apt_packages:
- cmake
2023-10-20 22:35:28 +00:00
- make
2023-10-23 22:49:38 +00:00
- git-lfs
2023-10-20 18:13:51 +00:00
tools:
2023-10-20 22:10:48 +00:00
python: '3.10'
jobs:
post_install:
2023-10-23 23:17:52 +00:00
- git lfs install --local
2023-10-23 23:24:50 +00:00
- git lfs fetch --include "*.png"
- git lfs checkout *.png
2023-10-24 14:35:06 +00:00
- cmake -B build -S . -DVTKm_ENABLE_DOCUMENTATION=ON -DVTKm_ENABLE_USERS_GUIDE=ON -DVTKm_USERS_GUIDE_INCLUDE_TODOS=OFF
2023-10-20 22:43:29 +00:00
- cmake --build build --target VTKmDoxygenDocs
2023-10-20 22:53:38 +00:00
- cp -f ./build/docs/users-guide/VTKmUsersGuideHTML.cache/conf.py docs/users-guide/conf.py
2023-10-20 18:13:51 +00:00
sphinx:
2023-10-20 22:53:38 +00:00
configuration: docs/users-guide/conf.py
2023-10-20 18:13:51 +00:00
2023-10-20 20:00:25 +00:00
python:
install:
2024-01-16 08:09:30 +00:00
- requirements: docs/users-guide/requirements.txt
2023-10-20 22:10:48 +00:00
formats:
- epub
2023-10-24 00:04:00 +00:00
- pdf