Convert the LaTeX docs to Sphinx + Myst Markdown extension I think this is in decent shape. It's going to need a lot of thorough proofreading to ensure that thing got lost or mangled on the way from the original docs. I suspect we will have several follow-up PRs to fix thing. After we're reasonably happy with it, we'll eventually remove the .tex and the pdf. Signed-off-by: Larry Gritz <lg@larrygritz.com>
30 lines
598 B
YAML
30 lines
598 B
YAML
# .readthedocs.yml
|
|
# Read the Docs configuration file
|
|
# 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
|
|
tools:
|
|
python: "3.11"
|
|
|
|
|
|
# Build documentation with Sphinx
|
|
sphinx:
|
|
configuration: src/doc/conf.py
|
|
|
|
|
|
# Optionally build your docs in additional formats such as PDF and ePub
|
|
formats:
|
|
- pdf
|
|
- htmlzip
|
|
|
|
|
|
# Optionally set the version of Python and requirements required to build your docs
|
|
python:
|
|
install:
|
|
- requirements: src/doc/requirements.txt
|