acrn-hypervisor/doc
David B. Kinder a2167ae93a doc: add extension to create files and raw links
Links to files in the GitHub repo's master branch should be to the files
within the branch being generated.  For example, in the v2.1
documentation, links should be to the v2.1 branch contents.  (Previously
links were being made to the master branch in all our archived content.)
This creates a problem when we want to remove an obsolete file in the
master branch but can't because older documentaiton incorrectly depends
on it.

This new extension defines a :acrn_file: and :acrn_raw: role that will
create links to the given file within the current commit branch.

This PR also replaces docs with hard-coded links to files in the master
branch with uses of these new roles to create links to files.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-11-05 09:17:05 -08:00
..
.known-issues doc: more prep for upgrading doc build tools 2020-11-01 10:12:17 -08:00
_templates doc: update breadcrumb to include release version 2020-10-01 14:53:29 -07:00
api doc: consistent spelling of passthrough 2020-06-18 12:46:26 -07:00
custom-doxygen
developer-guides doc: add extension to create files and raw links 2020-11-05 09:17:05 -08:00
extensions doc: add extension to create files and raw links 2020-11-05 09:17:05 -08:00
getting-started doc: improve GSG navigation 2020-11-03 15:14:32 -08:00
images doc: tweak 404 page for phone display 2020-04-08 18:22:14 -07:00
introduction doc: add extension to create files and raw links 2020-11-05 09:17:05 -08:00
reference doc: Spelling and grammar tweaks 2020-09-26 08:50:49 -07:00
release_notes doc: tweak 2.2 release notes 2020-10-01 12:31:12 -07:00
scripts doc: add copyright/license header to doc scripts 2020-07-29 19:08:02 -07:00
static doc: keep doxygen group descriptions in doc output 2020-07-10 13:50:58 -07:00
tutorials doc: add extension to create files and raw links 2020-11-05 09:17:05 -08:00
user-guides doc: Spelling and grammar tweaks 2020-09-26 08:50:49 -07:00
404.rst doc: fix columns issue with 404 page display 2020-06-05 16:44:15 -07:00
LICENSE
Makefile doc: remove /404.html redirect 2020-04-09 14:21:46 -07:00
README.md
acrn.doxyfile doc: update doxygen configuration 2020-10-26 09:20:50 -07:00
asa.rst doc: update security advisory for v2.1 release 2020-08-07 08:35:44 -07:00
conf.py doc: add extension to create files and raw links 2020-11-05 09:17:05 -08:00
contribute.rst doc: fix rst-columns display 2020-05-21 15:08:15 -07:00
develop.rst doc: add ivhshmem hv-land introduction 2020-09-14 10:20:39 -07:00
faq.rst doc: Spelling and grammar tweaks 2020-09-26 08:50:49 -07:00
genindex.rst doc: add sphinx-generated index to leftnav 2020-11-05 09:16:45 -08:00
glossary.rst doc: more prep for upgrading doc build tools 2020-11-01 10:12:17 -08:00
index.rst doc: add extension to create files and raw links 2020-11-05 09:17:05 -08:00
learn.rst Doc: Update re-org'd ACRN index page and What is ACRN. 2020-03-16 17:16:00 -04:00
nocl.rst doc: redirect to 2.1 version for delete docs 2020-09-30 14:41:16 -07:00
scorer.js doc: adjust search results to bias certain docs 2020-06-15 12:30:36 -07:00
substitutions.txt doc: continue doc restructuring 2019-08-01 14:07:22 -07:00
try.rst doc: spelling and grammar fixes 2020-08-20 08:09:21 -07:00

README.md

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