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>
PERL_PATH and MSCGEN_PATH are no longer used, so remove from Doxyfile.in
to avoid warning
warning Tag 'PERL_PATH' ... has become obsolete.
warning: Tag 'MSCGEN_PATH' ... has become obsolete.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
to provide access to maintainers information for this repository add it
to the input source files.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
in order to use the sphinx breathe plugin in the OpenAMP/openamp-docs
repository we need to enable xml generation
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
To allow for external links to doxygen generated content, tell doxygen
to build tags, so the tag file can be used for cross referencing
doxygen generated data.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
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>
Remove all remaining instances of "# vim: ..." in files.
This vim settings were part of the initial commit. But no reason
to keep them.
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
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>
This commit sets up the basic infrastructure necessary for the project:
- Documentation generation and installation using Doxygen.
- Configuration options and template headers with option substitution.
- Self-tests using cmake add_test() commands.
- Configurable selection, build, and install of static and shared
libraries, as well as handling for dependencies (libsysfs,
libhugetlbfs) for linux builds.
- Cross compilation for bare-metal and Linux target platforms.
- Basic infrastructure for initialization, logging, etc. and
separation between common, and system specific code.
Bill Mills
Sipke Vriend
Arnaud Pouliquen
Wendy Liang
Cyril Chemparathy