ReadTheDocs: eliminate the files no longer needed.

We now use the "git checkout command" in the RTDs project settings.
This means we will use the .readthedocs.yaml and conf.py from the
openamp-docs repo and no longer need these files in the sub-modules.

See openamp-docs/.readthedocs.yaml for details.

Signed-off-by: Bill Mills <bill.mills@linaro.org>
This commit is contained in:
Bill Mills
2026-06-02 14:07:52 +02:00
committed by Arnaud Pouliquen
parent 8740e728ff
commit c5389ea380
2 changed files with 0 additions and 65 deletions
-51
View File
@@ -1,51 +0,0 @@
# The main readthedocs build is in openamp-docs and includes this repo as a
# sub-module.
# This config file supports doc preview for PRs in this repo.
# This allows us to see how a PR in this repo will look in the docs before it
# is promoted to main and before the openamp-docs repo picks up the new version.
version: 2
# only do html, this is the case for PRs anyway but make sure
formats: []
sphinx:
# See comments in the file for why this is required
configuration: doc/readthedocs-conf.y
build:
os: "ubuntu-22.04"
tools:
python: "3.10"
apt_packages:
- cmake
- libhugetlbfs-dev
- libsysfs-dev
jobs:
post_checkout:
- echo "post_checkout"; pwd; echo $PATH; env; ls -la .
# we ignore the checkout they did and make a new one of the whole openamp-docs project
- git log -n 1 --oneline
- git rev-parse HEAD
- git clone --recurse-submodules https://github.com/OpenAMP/openamp-docs.git
# now adjust the focused submodule to the PR in progress
- echo "URL=${READTHEDOCS_GIT_CLONE_URL} COMMIT=${READTHEDOCS_GIT_COMMIT_HASH}"
- (cd openamp-docs/libmetal; git remote add this_pr ../../.git )
- (cd openamp-docs/libmetal; git fetch this_pr $(cd ../..; git rev-parse HEAD) )
- (cd openamp-docs/libmetal; git checkout $(cd ../..; git rev-parse HEAD) )
- (cd openamp-docs/libmetal; git log -n 1 --oneline)
- (cd openamp-docs; git submodule status)
post_install:
- echo "post_install"; pwd; echo $PATH; env; ls -la . openamp-docs
- python -m pip install --exists-action=w --no-cache-dir -r openamp-docs/requirements.txt
pre_build:
- echo "pre_build"; pwd; echo $PATH; env; ls -la . openamp-docs
- echo "READTHEDOCS_OUTPUT=$READTHEDOCS_OUTPUT"
- make -C openamp-docs BUILDDIR=$READTHEDOCS_OUTPUT doxygen
build:
html:
- echo "build"; pwd; echo $PATH; env; ls -la . openamp-docs
# This is the default build command as of 2025/01/12 but with
# "." changed to "openamp-docs"
- python -m sphinx -T -b html -d _build/doctrees -D language=en openamp-docs $READTHEDOCS_OUTPUT/html
post_build:
- echo "post_build"; pwd; echo $PATH; ls -la . openamp-docs
- make -C openamp-docs BUILDDIR=$READTHEDOCS_OUTPUT doxygen_copy
-14
View File
@@ -1,14 +0,0 @@
# Although RTDs now requires sphinx: configuration: it does not pass it to the
# build command and it still looks for conf.py in the current dir. It is
# confusing to have a conf.py that will only work in the very specific RTDs
# dir structure so we don't do that.
# So we supply a no-op config file and override the build command to run in the
# openamp-docs dir
# Since we have our own build command now, we could eliminate this file
# completely but that also disables the predefined sphinx steps of
# create_environment and install. The current setup keeps the build
# environment closer to that used by the real openamp-docs build
print("readthedocs-conf.py does nothing")