[PATCH 0/9] Convert documentation to rST

Stephen Finucane stephen at that.guru
Tue Apr 11 09:27:42 AEST 2017


This was suggested before but there wasn't any good reason to do it at the
time. There is now: reno. reno is a tool that allows us to provide rich release
notes alongside the code itself. It's used extensively in the OpenStack
community and I'd like to introduce it here too to allow us to provide detailed
release notes for the upcoming 2.0 release.

This is a manual conversion to rST that should result in basically the same
output.

Stephen Finucane (9):
  docs: Add skeleton for Sphinx docs
  docs: Convert README, index
  docs: Covert usage guide
  docs: Convert deployment guide
  docs: Convert development guide
  docs: Remove old Markdown files
  Add reno for release notes management
  docs: Use ReadTheDocs theme
  docs: Migrate release notes to rST

 .gitignore                                         |   3 +
 CHANGELOG.md                                       | 189 -------
 README.md                                          |  88 ---
 README.rst                                         |  91 +++
 UPGRADING.md                                       |   4 -
 docs/conf.py                                       | 100 ++++
 docs/deployment/index.rst                          |   8 +
 docs/deployment/installation.md                    | 489 ----------------
 docs/deployment/installation.rst                   | 614 +++++++++++++++++++++
 docs/deployment/{upgrading.md => upgrading.rst}    | 104 ++--
 docs/development/contributing.md                   |  59 --
 docs/development/contributing.rst                  |  73 +++
 docs/development/index.rst                         |  10 +
 docs/development/installation.md                   | 379 -------------
 docs/development/installation.rst                  | 488 ++++++++++++++++
 docs/development/{releasing.md => releasing.rst}   |  49 +-
 docs/development/xmlrpc.md                         |  54 --
 docs/development/xmlrpc.rst                        |  58 ++
 docs/{index.md => index.rst}                       |  51 +-
 docs/releases/alpaca.rst                           |  10 +
 docs/releases/burlap.rst                           |  99 ++++
 docs/releases/cashmere.rst                         |  82 +++
 docs/releases/index.rst                            |  10 +
 docs/releases/unreleased.rst                       |   4 +
 docs/usage/delegation.md                           |  45 --
 docs/usage/delegation.rst                          |  52 ++
 docs/usage/headers.md                              |  34 --
 docs/usage/headers.rst                             |  41 ++
 docs/usage/index.rst                               |  21 +
 docs/usage/{overview.md => overview.rst}           | 315 ++++++-----
 docs/usage/{rest.md => rest.rst}                   |  31 +-
 docs/usage/{xmlrpc.md => xmlrpc.rst}               |  31 +-
 mkdocs.yml                                         |  22 -
 releasenotes/config.yaml                           |   3 +
 .../notes/initial-reno-68c116ae9c5259a3.yaml       | 107 ++++
 tox.ini                                            |   8 +
 36 files changed, 2228 insertions(+), 1598 deletions(-)
 delete mode 100644 CHANGELOG.md
 delete mode 100644 README.md
 create mode 100644 README.rst
 delete mode 100644 UPGRADING.md
 create mode 100644 docs/conf.py
 create mode 100644 docs/deployment/index.rst
 delete mode 100644 docs/deployment/installation.md
 create mode 100644 docs/deployment/installation.rst
 rename docs/deployment/{upgrading.md => upgrading.rst} (60%)
 delete mode 100644 docs/development/contributing.md
 create mode 100644 docs/development/contributing.rst
 create mode 100644 docs/development/index.rst
 delete mode 100644 docs/development/installation.md
 create mode 100644 docs/development/installation.rst
 rename docs/development/{releasing.md => releasing.rst} (61%)
 delete mode 100644 docs/development/xmlrpc.md
 create mode 100644 docs/development/xmlrpc.rst
 rename docs/{index.md => index.rst} (66%)
 create mode 100644 docs/releases/alpaca.rst
 create mode 100644 docs/releases/burlap.rst
 create mode 100644 docs/releases/cashmere.rst
 create mode 100644 docs/releases/index.rst
 create mode 100644 docs/releases/unreleased.rst
 delete mode 100644 docs/usage/delegation.md
 create mode 100644 docs/usage/delegation.rst
 delete mode 100644 docs/usage/headers.md
 create mode 100644 docs/usage/headers.rst
 create mode 100644 docs/usage/index.rst
 rename docs/usage/{overview.md => overview.rst} (62%)
 rename docs/usage/{rest.md => rest.rst} (73%)
 rename docs/usage/{xmlrpc.md => xmlrpc.rst} (52%)
 delete mode 100644 mkdocs.yml
 create mode 100644 releasenotes/config.yaml
 create mode 100644 releasenotes/notes/initial-reno-68c116ae9c5259a3.yaml

-- 
2.9.3



More information about the Patchwork mailing list