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

doc: fix rst-columns display

Browse Source 
Using ``.. rst-class:: rst-columns`` wasn't processed correctly because
of an error in the acrn-custom.css file.  Fix that, update the
documentation guidelines, and make use of the multi-column display in
documents where the toctree created a long list.  Now it will
appear in columns.

Also tweaked the toctree listing to use bold for the first-level items
(making a multi-column display look better, particularly when it has
subsections).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2020-05-21 13:22:02 -07:00
committed by David Kinder
parent c606d060ec
commit 4db42c1c7f
6 changed files with 34 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/developer-guides/doc_guidelines.rst
View File

@@ -197,10 +197,11 @@ would be rendered as:
* space on
* the page
A maximum of three columns will be displayed, and change based on the
available width of the display window, reducing to one column on narrow
(phone) screens if necessary. We've deprecated use of the ``hlist``
directive because it misbehaves on smaller screens.
A maximum of three columns will be displayed if you use ``rst-columns``
or ``rst-columns3`` (and two columns for ``rst-columns2``), and change
based on the available width of the display window, reducing to one
column on narrow (phone) screens if necessary. We've deprecated use of
the ``hlist`` directive because it misbehaves on smaller screens.
Tables
******

2
doc/developer-guides/hld/index.rst
View File

@@ -13,6 +13,8 @@ These chapters describe the ACRN architecture, high-level design,
background, and motivation for specific areas within the ACRN hypervisor
system.
.. rst-class:: rst-columns
.. toctree::
:maxdepth: 2