mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-05-23 15:44:09 +00:00
42d9b24a54
In special cases, we'd like to freeze doc versions based on a tag (e.g.,
tags/acrn-2018w34.4-140000p) and have that version show up on the
generated docs. (Normally the version shown is from the
hypervisor/VERSION file.)
With this patch, if DOC_TAG=release then it uses a RELEASE=name
environment variable (e.g., from the make command line) to override the
displayed version:
make DOC_TAG=release RELEASE=acrn-2018w34.4-140000p html
make DOC_TAG=release RELEASE=acrn-2018w34.4-140000p publish
Assuming you've checked out the tagged branch (both for acrn-hypervisor
and acrn-kernel), these make commands will generate and publish docs to
https://projectacrn.github.io/acrn-2018w34.4-14000p
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
|
||
|---|---|---|
| .. | ||
| _templates | ||
| .known-issues | ||
| api | ||
| custom-doxygen | ||
| developer-guides | ||
| extensions | ||
| getting-started | ||
| images | ||
| introduction | ||
| reference/kconfig | ||
| scripts | ||
| static | ||
| tutorials | ||
| user-guides | ||
| acrn.doxyfile | ||
| conf.py | ||
| glossary.rst | ||
| hardware.rst | ||
| index.rst | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| release_notes_0.1.rst | ||
| release_notes_0.2.rst | ||
| release_notes.rst | ||
| substitutions.txt | ||
Project ACRN Documentation
This folder hold the source and configuration files used to generate the Project ACRN documentation web site published to https://projectacrn.github.io