Skip to content

Commit

Permalink
Add post-processing to build the Memory Management Reference.
Browse files Browse the repository at this point in the history
  • Loading branch information
rptb1 committed Mar 3, 2023
1 parent fd7dee6 commit 4146715
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@ build:
os: ubuntu-22.04
tools:
python: '3'
jobs:
# If MMREF is set then this config is being run to build the
# Memory Management Reference, which requires post-processing by
# the make-mmref.py script.
#
# FIXME: Duplicates code in manual/Makefile in a hacky way, but
# simply calling that Makefile would disable various Read the Docs
# features.
#
# See <https://docs.readthedocs.io/en/stable/build-customization.html#extend-the-build-process>.
post_build:
- if test -n "${MMREF}"; then \
mv "${READTHEDOCS_OUTPUT}/html" "${READTHEDOCS_OUTPUT}/mmref.in" && \
python manual/make-mmref.py "${READTHEDOCS_OUTPUT}/mmref.in" "${READTHEDOCS_OUTPUT}/html" \
fi

python:
install:
Expand All @@ -37,6 +52,7 @@ sphinx:
# B. DOCUMENT HISTORY
#
# 2023-02-02 RB Created as part of MPS GitHub migration.
# 2023-03-03 RB Updated to also build the Memory Management Reference.
#
#
# C. COPYRIGHT AND LICENSE
Expand Down

0 comments on commit 4146715

Please sign in to comment.