mirror of
https://github.com/microsoft/mscclpp.git
synced 2026-04-26 09:49:18 +00:00
4136153a76
Generate docs for mescclpp. Setup github action to auto-deploy github-page doc link here: https://microsoft.github.io/mscclpp --------- Co-authored-by: Changho Hwang <changhohwang@microsoft.com> Co-authored-by: Caio Rocha <caiorocha@microsoft.com>
37 lines
999 B
YAML
37 lines
999 B
YAML
# Read the Docs configuration file for Sphinx projects
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
# Set the OS, Python version and other tools you might need
|
|
build:
|
|
os: ubuntu-22.04
|
|
apt_packages:
|
|
- doxygen
|
|
tools:
|
|
python: "3.12"
|
|
jobs:
|
|
pre_build:
|
|
- cd docs && doxygen
|
|
|
|
# Build documentation in the "docs/" directory with Sphinx
|
|
sphinx:
|
|
configuration: docs/conf.py
|
|
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
|
|
# builder: "dirhtml"
|
|
# Fail on all warnings to avoid broken references
|
|
# fail_on_warning: true
|
|
|
|
# Optionally build your docs in additional formats such as PDF and ePub
|
|
# formats:
|
|
# - pdf
|
|
# - epub
|
|
|
|
# Optional but recommended, declare the Python requirements required
|
|
# to build your documentation
|
|
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
|
|
python:
|
|
install:
|
|
- requirements: docs/requirements.txt
|