Files
libmetal/doc/readthedocs-conf.py
Bill Mills 51719ef1da docs: update the readthedocs integration for PRs in this repo
Upstream Read The Docs has tightened up the schema checking and this broke
what we were doing for PRs.

A good number of things were tried but the best compromise is to:
* supply a dummy sphinx config file in this repo
* override the default build command to use the openamp-docs dir

Also:
* add more documentation about what is going on
* lock to html only format.  PRs only do html anyway but make sure

Signed-off-by: Bill Mills <bill.mills@linaro.org>
2025-02-14 16:43:20 +01:00

15 lines
683 B
Python

# 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")