Commit Graph

23 Commits

Author SHA1 Message Date
David B. Kinder 7f9779b736 doc: add skylake NUC w/GPU passthrough doc
Document a community reference release for the Skylake NUC with GPU
passthrough as a one-time snapshot release, not supported or
maintained.  Includes a tar patch file.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-09 09:45:06 -08:00
David B. Kinder 5ebaaaf973 doc: add CSS for non-compliant code examples
Coding guidelines have examples for compliant and non-compliant code,
but they look the same when rendered as HTML.  Add a CSS style for
non-compliant-code examples with a red-tinted background.

Usage is:
```
.. rst-class:: non-compliant-code

   .. code-block:: c

      a=b=c=0;
```
or, for example:

```
.. rst-class:: non-compliant-code

   Here's an example of non-compliant code::

      a=b=c=0;
```

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-26 11:09:46 -08:00
David B. Kinder 90d7bddd2f doc: vertical align table content to top
Default vertical alignment of "middle" doesn't look good on large
tables, so override to be "top" of the cell.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-12 15:28:59 -08:00
David B. Kinder e24039a7ef doc: tweak CSS for doxygen API usability
Change background colors of API elements to improve readability and
match configuration documentation look.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-05 11:44:27 -08:00
David B. Kinder d08256dfa9 doc: code-block text not readable
The .. code-block:: console directive (used for white text on a black
background) didn't handle some CSS cases properly resulting in
unreadable grey text on a black background.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 15:31:37 -07:00
David B. Kinder 56904bc235 doc: CSS tweak for table caption location
Default behavior is for figure captions below the figure, but table
captions above the table.  Tweak the CSS for tables to put the caption
below instead.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-08-01 11:18:49 -07:00
David B. Kinder ce7257e12e doc: tweak logo href to projectacrn.org
Have the logo link to the project site rather than the doc site

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-31 12:04:36 -07:00
David B. Kinder d4d8a128cf doc: tweak formatting for :kbd: role
update custom css to make kbd tag more interesting

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-30 16:13:03 -07:00
David B. Kinder 6c54cba985 doc: cleanup css, search, version choices
Update CSS customization to improve read-the-docs theme for our use.
Improved search results (removing most reST markup), improve display of
doc version choices.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-26 14:00:49 -07:00
David B. Kinder e04255822a doc: update GSG for v0.1, add console code-block
Console screen shots are hard to maintain, so use the
.. code-block:: console directive to show terminal console-like display
(black background with white text)

Change existing .. code-block:: console uses to .. code-block: none

Replace screen-shot images in apl-nuc getting started guide with
text-based console display.

Update apl-nuc GSG content with v0.1 changes

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-16 13:51:28 -07:00
David B. Kinder 6d63cb3cba doc: fix error in custom CSS file
Typo caused some styles to be missed

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-23 09:05:22 -07:00
Geoffroy Van Cutsem 12fb4b0584 doc: Adjust various scripts accordingly
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 18:02:07 +08:00
David B. Kinder 7dd647672c doc: GSG formating fix, RTD theme tweak
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>
2018-05-15 17:25:58 +08:00
David B. Kinder b997e590f2 doc: add support for publishing versioned docs
add navigation to (manually) maintained list (in conf.py) of versioned
docs, and update generating and publishing processes to be
version-aware.

Adds a file to redirect root references to /latest folder now (since we
can't update the server redirects).  Might break some links to pages
within the site from external sites.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:25:54 +08:00
David B. Kinder c8d2cdccda doc: update project documentation LICENSE
Per Project ACRN governance, documentation is under a Creative Commons
Attribution 4.0 International License (CC BY 4.0).  This patch updates
this information, and adds a tagline to documentation mentioning this
license.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder b170e295a7 doc: general edit for typos
Fix typos and misspellings, and tweak CSS for spacing before lists.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder af66e95112 doc: remove "under construction" tagline
we're getting close...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder da54bde3a7 doc: add Getting Started Guide
Initial version of Getting Started Guide doc (and images).
Need to replace images with better ones.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder 48df39c8fd doc: add 0.1 release notes
Initial version of 0.1 release notes, plus a CSS tweak for tables

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder b9b20fa6a8 doc: add developer primer
Developer Primer and images, and a tweak to figure formatting
also renamed from Hypervisor Primer to just Developer Primer since the
doc talks about Device Model too.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder ba121731b2 doc: add Technical intro doc
Add the "Introduction of Project Acorn" doc.

Also adds improvements to the doc generation processes, content styles,
removed doxygen-generated API material.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:29 +08:00
David B. Kinder 927dac7000 add in progress
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:28 +08:00
David B. Kinder d7938f8ca8 doc: initial doc commit
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00