On a Tuesday in 2020, Andrea Bolognani wrote:
We've adopted reStructuredText as the primary markup language for
our documentation and, given that both GitLab and GitHub can render
documents in this format just fine, it makes sense to get rid of
the few last remaining bits of Markdown and standardize on
reStructuredText across the board.
Signed-off-by: Andrea Bolognani <abologna@xxxxxxxxxx>
---
Note that I've taken a few liberties during the conversion when it
comes to formatting, with the goal of staying close to the style
used for existing reStructuredText documents, but I have not altered
the contents beyond that.
ABOUT-NLS | 2 +-
Makefile.am | 2 +-
README | 2 +-
README.md => README.rst | 55 ++++++++++++-----------
docs/Makefile.am | 2 +-
docs/fonts/{LICENSE.md => LICENSE.rst} | 30 +++++++++----
libvirt.spec.in | 2 +-
po/{README.md => README.rst} | 32 ++++++++-----
tools/wireshark/{README.md => README.rst} | 28 ++++++++----
9 files changed, 97 insertions(+), 58 deletions(-)
rename README.md => README.rst (65%)
rename docs/fonts/{LICENSE.md => LICENSE.rst} (94%)
rename po/{README.md => README.rst} (86%)
rename tools/wireshark/{README.md => README.rst} (52%)
diff --git a/README.md b/README.rst similarity index 65% rename from README.md rename to README.rst index 44b0dd87c5..663fba4510 100644 --- a/README.md +++ b/README.rst
[...]
@@ -1,6 +1,9 @@ -[](https://travis-ci.org/libvirt/libvirt) - [](https://bestpractices.coreinfrastructure.org/projects/355) +.. image:: https://travis-ci.org/libvirt/libvirt.svg + :alt: Travis CI Build Status +.. image:: https://bestpractices.coreinfrastructure.org/projects/355/badge + :alt: CII Best Practices +============================== Libvirt API for virtualization ============================== @@ -21,66 +24,66 @@ mappings into object systems such as GObject, CIM and SNMP. Further information about the libvirt project can be found on the website: -[https://libvirt.org](https://libvirt.org) +https://libvirt.org License -------- +======= The libvirt C API is distributed under the terms of GNU Lesser General Public License, version 2.1 (or later). Some parts of the code that are not part of the C library may have the more restrictive GNU General -Public License, version 2.0 (or later). See the files `COPYING.LESSER` -and `COPYING` for full license terms & conditions. +Public License, version 2.0 (or later). See the files ``COPYING.LESSER`` +and ``COPYING`` for full license terms & conditions. Installation ------------- +============ Libvirt uses the GNU Autotools build system, so in general can be built and installed with the usual commands, however, we mandate to have the build directory different than the source directory. For example, to build in a manner that is suitable for installing as root, use: -``` -$ mkdir build && cd build -$ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var -$ make -$ sudo make install -``` +::
Side question: Are we against putting :: at the end of the previous line? I think it looks slightly better that way.
+ + $ mkdir build && cd build + $ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var + $ make + $ sudo make install While to build & install as an unprivileged user -``` -$ mkdir build && cd build -$ ../configure --prefix=$HOME/usr -$ make -$ make install -``` +:: + + $ mkdir build && cd build + $ ../configure --prefix=$HOME/usr + $ make + $ make install The libvirt code relies on a large number of 3rd party libraries. These will -be detected during execution of the `configure` script and a summary printed +be detected during execution of the ``configure`` script and a summary printed which lists any missing (optional) dependencies. Contributing ------------- +============ The libvirt project welcomes contributions in many ways. For most components the best way to contribute is to send patches to the primary development mailing list. Further guidance on this can be found on the website: -[https://libvirt.org/contribute.html](https://libvirt.org/contribute.html) +https://libvirt.org/contribute.html Contact -------- +======= The libvirt project has two primary mailing lists: - * libvirt-users@xxxxxxxxxx (**for user discussions**) - * libvir-list@xxxxxxxxxx (**for development only**) +* libvirt-users@xxxxxxxxxx (**for user discussions**) +* libvir-list@xxxxxxxxxx (**for development only**) Further details on contacting the project are available on the website: -[https://libvirt.org/contact.html](https://libvirt.org/contact.html) +https://libvirt.org/contact.html diff --git a/docs/Makefile.am b/docs/Makefile.am index 404121a2a2..6860efc888 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -118,7 +118,7 @@ javascriptdir = $(HTML_DIR)/js javascript_DATA = $(javascript) fonts = \ - fonts/LICENSE.md \ + fonts/LICENSE.rst \ fonts/stylesheet.css \ fonts/overpass-bold-italic.woff \ fonts/overpass-bold.woff \ diff --git a/docs/fonts/LICENSE.md b/docs/fonts/LICENSE.rst similarity index 94% rename from docs/fonts/LICENSE.md rename to docs/fonts/LICENSE.rst index 9520f30f73..4e32b1a1d3 100644 --- a/docs/fonts/LICENSE.md +++ b/docs/fonts/LICENSE.rst @@ -1,18 +1,24 @@ -## License +======= +License +======= Copyright (C) 2015 Red Hat, Inc., This Font Software is licensed under the SIL Open Font License, Version 1.1. This license is copied below, and is also available with a FAQ at: + http://scripts.sil.org/OFL -#### SIL OPEN FONT LICENSE +===================== +SIL OPEN FONT LICENSE +===================== +
Why were the headings so small in the first place? Reviewed-by: Ján Tomko <jtomko@xxxxxxxxxx> Jano
Attachment:
signature.asc
Description: PGP signature
