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>
Allow Zephyr testing to either use locked known good values
or the very latest versions.
This brings open-amp to parity with libmetal. Open-amp did not have the
SDK URL discovery code so that was added here as part of this.
The known good versions are best for PR checking as if the build fails
it is almost always the PR itself that broke it.
The latest version is good for periodically checking compatibility with
the very latest Zephyr changes.
For now we run both on pushes and PRs.
We also run main against the latest zephyr check weekly as a look ahead.
Signed-off-by: Bill Mills <bill.mills@linaro.org>
Reduce the console output for the Zephyr sdk install.
This now matches the intent of libmetal but uses the documented wget
option.
Signed-off-by: Bill Mills <bill.mills@linaro.org>
Detect when we are a submodule of OpenAMP-docs.
If so use the top level's Doxyfile overrides on top of our Doxyfile.
If not, no change.
Signed-off-by: Bill Mills <bill.mills@linaro.org>
The Readthedocs pull-request integration is nice to have for PR review.
So run the whole OpenAMP-docs build but use the PR's commit
This also requires a ReadTheDocs project to install its integration for
this repo. The project should enable "Build pull request for this project".
It is currently in the Advanced Settings panel.
The project will also run for the main branch but that should be
ignored and only the main project URL should be shown outside of PRs.
To this end the sub-module project names will use "-prs" in the name.
Signed-off-by: Bill Mills <bill.mills@linaro.org>
Bill Mills