OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: update doc build tools for Ubuntu 22.04 and Sphinx 

Update known-issues processing and tweak conf.py and requirements.txt
(for PyPI package versions) to handle a broader version of
doc-generation tools (sphinx, breathe, docutils, etc.).  This should
let us move to Ubuntu 22.04 while maintaining doc-build compatibility
with older tool versions available with Ubuntu 20.04 (doxygen in particular).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2022-10-19 09:27:45 -07:00 committed by David Kinder
parent b16aae48d0
commit 38f8097b54
3 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/.known-issues/doc/sphinx.conf Normal file
View File

@ -0,0 +1,5 @@
# Known Sphinx generation messages to ignore
#
#
^WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly.*$
#

6
doc/conf.py
View File

@ -45,8 +45,8 @@ extensions = [
# extlinks provides a macro template # extlinks provides a macro template
extlinks = {'acrn-commit': ('https://github.com/projectacrn/acrn-hypervisor/commit/%s', ''), extlinks = {
'acrn-issue': ('https://github.com/projectacrn/acrn-hypervisor/issues/%s', '') 'acrn-issue': ('https://github.com/projectacrn/acrn-hypervisor/issues/%s', '#')
} }
# use intersphinx linking to link to previous version release notes # use intersphinx linking to link to previous version release notes
@ -128,7 +128,7 @@ finally:
# #
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # Usually you set "language" from the command line for these cases.
language = None language = 'en'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.

10
doc/scripts/requirements.txt
View File

@ -1,5 +1,5 @@
breathe>=4.23.0,<=4.31 breathe>=4.23
sphinx>=3.2.1,<=3.5.4 sphinx>=3.2.1,<6.0
docutils==0.16 docutils>=0.16,<=0.17.1
sphinx_rtd_theme==1.0 sphinx_rtd_theme==1.0.0
sphinx-tabs==1.3.0 sphinx-tabs>=1.3.0,<=3.4.0