Files
xen/docs/index.rst
T
Andrew Cooper b05c8fe1a6 docs/sphinx: Introduce a hypervisor guide section
Include (and retrofit to the user guide) an introductory paragraph describing
the intended audience.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
2019-04-05 18:25:25 +01:00

35 lines
860 B
ReStructuredText

The Xen Hypervisor documentation
================================
.. note::
Xen's Sphinx/RST documentation is a work in progress. The existing
documentation can be found at https://xenbits.xen.org/docs/
User documentation
------------------
This is documentation for an administrator of a Xen system. It is intended
for someone who is not necesserily a developer, has installed Xen from their
preferred distribution, and is attempting to run virtual machines and
configure the system.
.. toctree::
:maxdepth: 2
admin-guide/index
Hypervisor developer documentation
----------------------------------
This is documentation for a hypervisor developer. It is intended for someone
who is building Xen from source, and is running the new hypervisor in some
kind of development environment.
.. toctree::
:maxdepth: 2
hypervisor-guide/index