Documentation for Argo

Description

Write documentation for Argo for Xen, OpenXT and uXen (as Argo is integrated) - requested by upstream Xen community and will assist development and adoption.

reference notes from inspecting the Xen docs build process:

The older part of Xen’s build uses a tool called pandoc to transform the documentation source in the Xen repository into the documentation output material. pandoc is written in Haskell - instructions from building from source are included on this page:
https://pandoc.org/installing.html
and the reference page for the package is here:
https://hackage.haskell.org/package/pandoc
Note that meta-virtualization doesn’t have the Haskell compiler, etc. available, either within its own layer or the set of layers that it requires as dependencies.

Fortunately the source format for the Xen docs is clear and human-readable, and binaries for pandoc are available on the above page or via distro repositories.

The newer documentation build that Xen has uses sphinx and producing those docs does not require pandoc.
See: sphinx-html build target to build the newer “read the docs” style of Xen documentation

make -C docs sphinx-html

(eg. https://andrewcoop-xen.readthedocs.io/en/docs-devel/admin-guide/index.html )

sphinx itself has the following dependencies which need to be available:

install_requires = [
'six>=1.5',
'Jinja2>=2.3',
'Pygments>=2.0',
'docutils>=0.11',
'snowballstemmer>=1.1',
'babel>=1.3,!=2.0',
'alabaster>=0.7,<0.8',
'imagesize',
'requests>=2.0.0',
'setuptools',
'packaging',
'sphinxcontrib-websupport',
]

Once all the above are made available (and their dependencies) as native packages for OE, it is possible to build the sphinx documentation within a meta-virtualization devshell, with the make command above.

Validation Steps

None

Assignee

Christopher Clark

Reporter

Christopher Clark

Labels

None

QA Assignee

None

QA Image URL

None

Priority

Critical
Configure