[for-4.13,0/4] docs/sphinx

Message

Andrew Cooper Oct. 3, 2019, 8:56 p.m. UTC

Various pieces of Sphinx documentation improvements intended for inclusion
into Xen 4.13.  Rendered results can be viewed at

  https://andrewcoop-xen.readthedocs.io/en/docs-devel/index.html

with

  https://andrewcoop-xen.readthedocs.io/en/docs-devel/admin-guide/introduction.html
  https://andrewcoop-xen.readthedocs.io/en/docs-devel/glossary.html
  https://andrewcoop-xen.readthedocs.io/en/docs-devel/misc/tech-debt.html

being the notable additions from this series.

Andrew Cooper (4):
  docs/sphinx: License content with CC-BY-4.0
  docs/sphinx: Indent cleanup
  docs/sphinx: Introduction
  docs/sphinx: Technical Debt

 COPYING                                  |   3 +
 docs/README.source                       |  32 ++++++++
 docs/admin-guide/index.rst               |   5 +-
 docs/admin-guide/introduction.rst        |  40 ++++++++++
 docs/admin-guide/microcode-loading.rst   |   2 +
 docs/admin-guide/xen-overview.drawio.svg |  97 +++++++++++++++++++++++
 docs/conf.py                             |  12 ++-
 docs/glossary.rst                        |  52 +++++++++++++
 docs/guest-guide/index.rst               |   6 +-
 docs/guest-guide/x86/hypercall-abi.rst   |  52 +++++++------
 docs/guest-guide/x86/index.rst           |   6 +-
 docs/hypervisor-guide/code-coverage.rst  |   6 +-
 docs/hypervisor-guide/index.rst          |   6 +-
 docs/index.rst                           |  38 +++++++--
 docs/misc/tech-debt.rst                  | 130 +++++++++++++++++++++++++++++++
 15 files changed, 444 insertions(+), 43 deletions(-)
 create mode 100644 docs/README.source
 create mode 100644 docs/admin-guide/introduction.rst
 create mode 100644 docs/admin-guide/xen-overview.drawio.svg
 create mode 100644 docs/glossary.rst
 create mode 100644 docs/misc/tech-debt.rst

Comments

Jürgen Groß Oct. 4, 2019, 4:53 a.m. UTC | #1

On 03.10.19 22:56, Andrew Cooper wrote:
> Various pieces of Sphinx documentation improvements intended for inclusion
> into Xen 4.13.  Rendered results can be viewed at
> 
>    https://andrewcoop-xen.readthedocs.io/en/docs-devel/index.html
> 
> with
> 
>    https://andrewcoop-xen.readthedocs.io/en/docs-devel/admin-guide/introduction.html
>    https://andrewcoop-xen.readthedocs.io/en/docs-devel/glossary.html
>    https://andrewcoop-xen.readthedocs.io/en/docs-devel/misc/tech-debt.html
> 
> being the notable additions from this series.
> 
> Andrew Cooper (4):
>    docs/sphinx: License content with CC-BY-4.0
>    docs/sphinx: Indent cleanup
>    docs/sphinx: Introduction
>    docs/sphinx: Technical Debt
> 
>   COPYING                                  |   3 +
>   docs/README.source                       |  32 ++++++++
>   docs/admin-guide/index.rst               |   5 +-
>   docs/admin-guide/introduction.rst        |  40 ++++++++++
>   docs/admin-guide/microcode-loading.rst   |   2 +
>   docs/admin-guide/xen-overview.drawio.svg |  97 +++++++++++++++++++++++
>   docs/conf.py                             |  12 ++-
>   docs/glossary.rst                        |  52 +++++++++++++
>   docs/guest-guide/index.rst               |   6 +-
>   docs/guest-guide/x86/hypercall-abi.rst   |  52 +++++++------
>   docs/guest-guide/x86/index.rst           |   6 +-
>   docs/hypervisor-guide/code-coverage.rst  |   6 +-
>   docs/hypervisor-guide/index.rst          |   6 +-
>   docs/index.rst                           |  38 +++++++--
>   docs/misc/tech-debt.rst                  | 130 +++++++++++++++++++++++++++++++
>   15 files changed, 444 insertions(+), 43 deletions(-)
>   create mode 100644 docs/README.source
>   create mode 100644 docs/admin-guide/introduction.rst
>   create mode 100644 docs/admin-guide/xen-overview.drawio.svg
>   create mode 100644 docs/glossary.rst
>   create mode 100644 docs/misc/tech-debt.rst
> 

For the series:

Release-acked-by: Juergen Gross <[e-mail]>


Juergen