diff options
| author | Andrew Cooper <andrew.cooper3@citrix.com> | 2018-11-21 17:03:50 +0000 |
|---|---|---|
| committer | Andrew Cooper <andrew.cooper3@citrix.com> | 2019-03-22 13:48:02 +0000 |
| commit | 530f9aababc9bc0ab8405252364d07f2830c2793 (patch) | |
| tree | 03c1dc94a067b1b8348d2eada474a1a8cd1fbd44 /docs/index.rst | |
| parent | 74dadb8556c6a0972fa422b5ae346589ace404b6 (diff) | |
docs/sphinx: Skeleton setup
Sphinx is a documentation system, which is popular for technical writing. It
uses ReStructuredText as its markup syntax, and is designed for whole-project
documentation, rather than the misc assortment of individual files that we
currently have.
This is a skeleton setup which just enough infrastructure to render an empty
set of pages. It will become better integrated into Xen's docs system when it
becomes less WIP.
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000..20f097ddb0 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,7 @@ +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/ |