1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-03-26 08:41:47 -07:00

Adding a configuration for read the docs.

This commit is contained in:
Richard Brooksby 2023-02-02 04:12:42 +00:00
parent fa42d5c381
commit 1bfa2f2917
3 changed files with 26 additions and 6 deletions

16
mps/.readthedocs.yaml Normal file
View file

@ -0,0 +1,16 @@
# .readthedocs.yaml -- Build configuration for MPS manual on Read The Docs
#
# See https://docs.readthedocs.io/en/stable/config-file/v2.html
version: 2
formats: all
build:
os: ubuntu-22.04
tools:
python: 3
python:
install:
- requirements: manual/requirements.pip

View file

@ -2,6 +2,7 @@
# $Id$
# You can set these variables from the command line.
PYTHON = python3
SPHINXOPTS =
SPHINXBUILD = tool/bin/sphinx-build
PAPER =
@ -154,12 +155,11 @@ doctest: $(SPHINXBUILD)
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
tools: tool/bin/sphinx-build
.PHONY: tools
tools: tool/bin/pip requirements.pip
tool/bin/pip install -r requirements.pip
tool/bin/sphinx-build: tool/bin/pip
tool/bin/pip install 'sphinx < 5' # Layout breaks in Sphinx >= 5. See <https://github.com/Ravenbrook/mps/issues/121>.
@echo "You can now use \`make SPHINXBUILD=tool/bin/sphinx-build html' etc."
@echo "Or add tool/bin to your path."
tool/bin/sphinx-build: tools
tool/bin/pip:
python3 -mvenv tool
$(PYTHON) -mvenv tool

View file

@ -0,0 +1,4 @@
# manual/requirements.txt -- MPS manual build requirements for pip
# Layout breaks in Sphinx >= 5. See <https://github.com/Ravenbrook/mps/issues/121>.
sphinx >= 4, < 5