internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-06 21:32:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Convert README from Markdown to ReStructured Text and use as longdesc (#22330)

Browse Source 
* Convert README from Markdown to ReStructured Text and use as longdesc

Discussion in #13758 led to deciding to switch README to rst and having
setup.py consume it as the long_description.

* Fix long string in setup.py for pep8 compliance

* Open README.rst as read-only

* Update usages of root README.md to README.rst

Unsure about the file ./packaging/debian/docs as it (only) contains the
text README.md. I believe it's referencing ./packaging/debian/README.md
but maybe someone who knows debian packaging could review it?

* Pick up fixes that had been merged into README.md after the initial conversion to rst
This commit is contained in:
Stephen Weber
2018-04-06 12:38:40 -07:00
committed by Toshio Kuratomi
parent f1b63f435e
commit 7afa34ae8a
7 changed files with 120 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packaging/macports/sysutils/ansible/Portfile
View File

@@ -45,7 +45,7 @@ patch {
post-destroot {
# documentation and examples
xinstall -m 644 -W ${worksrcpath} README.md CHANGELOG.md CONTRIBUTING.md COPYING \
xinstall -m 644 -W ${worksrcpath} README.rst CHANGELOG.md CONTRIBUTING.md COPYING \
${destroot}${prefix}/share/doc/${name}
xinstall -m 755 -d ${destroot}${prefix}/share/doc/examples