mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-04-28 19:54:01 +00:00
8b0d1e45b9
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>
66 lines
1.8 KiB
ReStructuredText
66 lines
1.8 KiB
ReStructuredText
.. _release_notes:
|
|
|
|
Release Notes
|
|
#############
|
|
|
|
ACRN is a flexible, lightweight reference hypervisor, built with real-time and
|
|
safety-criticality in mind, optimized to streamline embedded development through
|
|
an open source platform. Check out the :ref:`introduction` for more information.
|
|
|
|
The project ACRN reference code can be found on GitHub in
|
|
https://github.com/projectacrn. It includes the ACRN hypervisor, the ACRN
|
|
Device Model, and documentation.
|
|
|
|
.. comment Maintain current release notes in the master branch/latest docs
|
|
|
|
.. rst-class:: rst-columns
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
:reversed:
|
|
|
|
release_notes_*
|
|
|
|
Release Notes Archive
|
|
*********************
|
|
|
|
Release notes for previous releases are available in the project documentation
|
|
archives:
|
|
|
|
.. comment Maintain this list of archived release notes manually as needed. As
|
|
configured in conf.py, these documents are found in the v2.7 documentation using
|
|
the intersphinx extension. (That was the last release where we generated
|
|
all the previous release notes in one place.)
|
|
|
|
.. rst-class:: rst-columns
|
|
|
|
|
|
- :ref:`release_notes_2.7`
|
|
- :ref:`release_notes_2.6`
|
|
- :ref:`release_notes_2.5`
|
|
- :ref:`release_notes_2.5.1`
|
|
- :ref:`release_notes_2.4`
|
|
- :ref:`release_notes_2.3`
|
|
- :ref:`release_notes_2.2`
|
|
- :ref:`release_notes_2.1`
|
|
- :ref:`release_notes_2.0`
|
|
- :ref:`release_notes_1.6`
|
|
- :ref:`release_notes_1.6.1`
|
|
- :ref:`release_notes_1.5`
|
|
- :ref:`release_notes_1.4`
|
|
- :ref:`release_notes_1.3`
|
|
- :ref:`release_notes_1.2`
|
|
- :ref:`release_notes_1.1`
|
|
- :ref:`release_notes_1.0`
|
|
- :ref:`release_notes_1.0.1`
|
|
- :ref:`release_notes_1.0.2`
|
|
- :ref:`release_notes_0.8`
|
|
- :ref:`release_notes_0.7`
|
|
- :ref:`release_notes_0.6`
|
|
- :ref:`release_notes_0.5`
|
|
- :ref:`release_notes_0.4`
|
|
- :ref:`release_notes_0.3`
|
|
- :ref:`release_notes_0.2`
|
|
- :ref:`release_notes_0.1`
|