github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-10 21:29:20 +00:00
Code Issues Projects Releases Wiki Activity

doc: add tool for verifying installed doc tools

Browse Source 
Added a python script that displays versions of doc building tools
(e.g., doxygen, breathe, sphinx) to help verify doc building environment
is properly set up (can help doc building problem diagnostic, as shown
in issue #1333

Update doc build documentation to reference this script.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2018-09-26 09:51:25 -07:00
committed by David Kinder
parent c30437de9b
commit 68ce114b43
3 changed files with 30 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/tutorials/docbuild.rst
View File

@@ -130,7 +130,7 @@ Our documentation processing has been tested to run with:
* Python 3.6.3
* Doxygen version 1.8.13
* Sphinx version 1.7.5
* Sphinx version 1.7.7
* Breathe version 4.9.1
* docutils version 0.14
* sphinx_rtd_theme version 0.4.0
@@ -160,6 +160,13 @@ tools:
And with that you're ready to generate the documentation.
.. note::
We've provided a script you can run to show what versions of the
doc building tools you have installed ::
doc/scripts/show-versions.py
Documentation presentation theme
********************************