Commit Graph

15 Commits

Author SHA1 Message Date
David B. Kinder
d1e281f6eb doc: add graphviz extension
graphviz lets us create graphic images via a text language rather than
creating drawings in other tools (eliminating the need to keep the
sources for the images available, such as a powerpoint file).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-06 15:12:31 -07:00
David B. Kinder
d11729d9d8 doc: add doc contributing guide, plus cleanup
Add documentation contributing information with project specific
recommentations along with some common reST and Sphinx constructs.
Reorganize contributing section to fit this new doc in.

Also

* Cleanup stray file (CODEOWNERS) from when docs were in their own repo.
* Remove licensing footer on generated pages (not really needed).
* Pull replacement strings into substitutions.txt for easier management.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-23 08:44:56 -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
e35874cae1 doc: introduce howto area for technical notes
Tech note articles about technology and process tips now have a place in
the ACRN documentaion.

Move the doc process documention into this new area, and add a
placeholder for tech tips for now.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:25:57 +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
3b86c9710e doc: improvements for sphinx generation
Handle version retrieval better when comments are present.
Add warning if Sphinx theme (read_the_docs) is missing.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:36 +08:00
David B. Kinder
df5c261362 doc: update display of RC version
Change display of RC_VERSION on documents to be
  vMAJOR_VERSION.MINOR_VERSION-rcRC_VERSION
if RC_VERSION is non-zero, otherwise only
  vMAJOR_VERSION.MINOR_VERSION

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder
b03cda69d1 doc: update build process to get RC_VERSION
Doc version tracking with acrn-hypervisor version now to be
MAJOR_VERSION . MINOR_VERSION . RC_VERSION

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:29 +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
b966397914 add supported hardware
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder
4d102928fc doc: set version to 0.1
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder
30a65876ca doc: add favicon
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder
dce61618dc doc: organizational and look improvements
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +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