github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-10-07 01:05:12 +00:00
Code Issues Projects Releases Wiki Activity

doc: reference old release notes in archived release docs

Browse Source 
Instead of trying to maintain the release notes for old releases in the
current release, reference them in a previous archive.  This eliminates
the need to fix doc build errors by editing old release notes that
reference material that no longer exists in the newer release.

We use the intersphinx extension to support references to
Sphinx-generated content from other projects.  In our case, we're
referencing the archived version of v2.7 documents that was the last
release to generate release notes for all previous releases. This import
is done in conf.py.

(Alternatively we could reference the release notes for a release in
that specific release's archive, but that means fetchind the intersphinx
inventory file (objects.inv) for every release, and seems like
overkill.)

This modification still allows putting multiple release notes in the
doc/release_notes folder and they'll show up in the release notes index
as they have in the past.  Update the separate "archived" release notes
section manually as needed.

Also, adds a draft of the v3.0 release notes to verify the new release
notes index page layout.

Fixes: #7171

Tracked-On: #7171

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2022-04-02 13:53:07 -07:00
committed by David Kinder
parent 0494017f89
commit 8b0d1e45b9
30 changed files with 137 additions and 9665 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/conf.py
View File

@@ -39,7 +39,7 @@ if "RELEASE" in os.environ:
sys.path.insert(0, os.path.join(os.path.abspath('.'), 'extensions'))
extensions = [
'breathe', 'sphinx.ext.graphviz', 'sphinx.ext.extlinks',
'eager_only', 'html_redirects', 'link_roles',
'eager_only', 'html_redirects', 'link_roles','sphinx.ext.intersphinx',
'sphinx_tabs.tabs', 'last_updated'
]
@@ -49,6 +49,12 @@ extlinks = {'acrn-commit': ('https://github.com/projectacrn/acrn-hypervisor/comm
'acrn-issue': ('https://github.com/projectacrn/acrn-hypervisor/issues/%s', '')
}
# use intersphinx linking to link to previous version release notes
# (We only need to link to an archive that has the older release notes)
intersphinx_mapping = {
'v2.7': ('https://projectacrn.github.io/2.7', None),
}
graphviz_output_format='png'
graphviz_dot_args=[