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

doc: GSG formating fix, RTD theme tweak

Browse Source 
Fix some formatting problems with a recent GSG update.  Tweak the
custom CSS to adjust code block (and code literal) colors.  Update
Makefile to document doc build options for pulling source from the other
repos and for publishing targets.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-05-04 09:41:59 -07:00
parent 49e79dee10
commit 7468bf8f52
4 changed files with 34 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Makefile
View File

@ -21,6 +21,14 @@ PUBLISHDIR = ../projectacrn.github.io/$(RELEASE)
# Put it first so that "make" without argument is like "make help". # Put it first so that "make" without argument is like "make help".
help: help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@echo ""
@echo "make pullsource"
@echo " fetch and merge upstream source for the project ACRN code repos"
@echo ""
@echo "make publish"
@echo " publish generated html to projectacrn.github.io site:"
@echo " specify RELEASE=name to publish as a tagged release version"
@echo " and placed in a version subfolder"
.PHONY: help Makefile .PHONY: help Makefile

26
getting_started/index.rst
View File

@ -113,11 +113,11 @@ partition. Follow these steps:
kernel-org.clearlinux.pk414-standard.4.14.34-28 kernel-org.clearlinux.pk414-standard.4.14.34-28
loaderx64.efi loaderx64.efi
.. note:: .. note::
The Clear Linux project releases updates often, sometimes The Clear Linux project releases updates often, sometimes
twice a day, so make note of the specific kernel versions (``*-sos`` twice a day, so make note of the specific kernel versions (``*-sos``
and ``*-standard``) listed on your system, and ``*-standard``) listed on your system,
as you will need them later. as you will need them later.
#. Put the ``acrn.efi`` hypervisor application (included in the Clear #. Put the ``acrn.efi`` hypervisor application (included in the Clear
Linux release) on the EFI partition with: Linux release) on the EFI partition with:
@ -140,13 +140,14 @@ partition. Follow these steps:
# cd /mnt/EFI/org.clearlinux/ # cd /mnt/EFI/org.clearlinux/
# cp bootloaderx64.efi bootloaderx64_origin.efi # cp bootloaderx64.efi bootloaderx64_origin.efi
.. note:: .. note::
Be aware that a Clearlinux update that includes a kernel upgrade will Be aware that a Clearlinux update that includes a kernel upgrade will
reset this. A Clearlinux update could happen automatically (if you have reset the boot option changes you just made.. A Clearlinux update could
not disabled it as described above), if you later install a new happen automatically (if you have
bundle to your system or simply if you decide to trigger an update not disabled it as described above), if you later install a new
manually. Whenever that happens, double-check the platform boot order bundle to your system, or simply if you decide to trigger an update
using ``efibootmgr -v`` and modify it if needed. manually. Whenever that happens, double-check the platform boot order
using ``efibootmgr -v`` and modify it if needed.
#. Create a boot entry for the ACRN Service OS by copying a provided ``acrn.conf`` #. Create a boot entry for the ACRN Service OS by copying a provided ``acrn.conf``
and editing it to account for the kernel versions noted in a previous step. and editing it to account for the kernel versions noted in a previous step.
@ -196,6 +197,7 @@ partition. Follow these steps:
.. figure:: images/gsg-bootmenu.png .. figure:: images/gsg-bootmenu.png
:align: center :align: center
:width: 650px
:name: gsg-bootmenu :name: gsg-bootmenu
ACRN Service OS Boot menu ACRN Service OS Boot menu

2
scripts/publish-index.html
View File

@ -5,6 +5,6 @@
<meta name="keywords" content="automatic redirection"> <meta name="keywords" content="automatic redirection">
</head> </head>
<body> <body>
Please visit the <a href="/latest/">latest ARCN documentation</a> Please visit the <a href="/latest/">latest ACRN documentation</a>
</body> </body>
</html> </html>

13
static/acrn-custom.css
View File

@ -14,12 +14,12 @@
} }
*/ */
/* tweak doc version selection */ /* tweak doc version selection
.rst-versions { .rst-versions {
position: static; position: static;
border-top: none; border-top: none;
padding: 0px; padding: 0px;
} } */
.rst-versions .rst-current-version { .rst-versions .rst-current-version {
padding: 5px; padding: 5px;
@ -35,6 +35,15 @@ div.rst-other-versions dl {
margin-bottom: 0; margin-bottom: 0;
} }
/* code block highlight color in rtd changed to lime green, no no no */
.rst-content tt.literal, .rst-content code.literal, .highlight {
background: #f0f0f0;
}
.rst-content tt.literal, .rst-content code.literal {
color: #000000;
}
/* Make the version number more visible */ /* Make the version number more visible */
.wy-side-nav-search>div.version { .wy-side-nav-search>div.version {
color: rgba(255,255,255,1); color: rgba(255,255,255,1);