[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Xen-devel] [PATCH 0/3] docs: User oriented documentation



This is a project I've been musing over for a long time now, to try and
address Xen's almost complete absense of documentation.

This series, plus some other in-progress conversion of the command line doc,
is available to view at:

  https://andrewcoop-xen.readthedocs.io/en/latest/

This is read-the-docs's automatic CI build of documentation from a branch on
gitlab.  Observe that the docs don't look like they are out of the 90's, and
are automatically translated into PDF and ePUB format as well.

In due course I'll see about updating xenbits.xen.org/docs to render this as
well, but I don't have sufficient tuits at the moment.

Andrew Cooper (3):
  docs/sphinx: Skeleton setup
  docs/rst: Use pandoc to render ReStructuredText
  docs/admin-guide: Boot time microcode loading

 docs/Makefile                          |  24 +++-
 docs/admin-guide/index.rst             |   5 +
 docs/admin-guide/microcode-loading.rst | 103 ++++++++++++++++++
 docs/conf.py                           | 193 +++++++++++++++++++++++++++++++++
 docs/index.rst                         |  10 ++
 docs/sphinx/requirements.txt           |   3 +
 6 files changed, 336 insertions(+), 2 deletions(-)
 create mode 100644 docs/admin-guide/index.rst
 create mode 100644 docs/admin-guide/microcode-loading.rst
 create mode 100644 docs/conf.py
 create mode 100644 docs/index.rst
 create mode 100644 docs/sphinx/requirements.txt

-- 
2.1.4


_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/xen-devel

 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.