search

dtrx-py / dtrx

Do The Right Extraction
GNU General Public License v3.0
231 stars 10 forks source link

(re)Allow building manpages from the README #2

Closed dilinger closed 4 years ago

dilinger commented 4 years ago

Previously, the README file was in reStructuredText format. As the v6.5 entry in the NEWS file states, "The README is now written like a man page, and can be converted to a man page by using rst2man_." The conversion to a pypi-friendly format broke that.

I don't know what format the README is currently in - the nearest I can figure out is github-flavored markdown? Either way, pandoc doesn't properly convert it from gfm to rst in a form that rst2man understands. These patches make it at least work, although it's still not 100% proper. Ideally there would be an option to build the man page during build for distributions or non-pip installations.

Please let me know if I guessed the wrong format, and/or if there's a way to have python generate a .rst or manpage file.

dilinger commented 4 years ago

BTW, according to this rst is supported by pypi for the README: https://packaging.python.org/guides/making-a-pypi-friendly-readme/

So I'd be just as happy to send patches to convert the README back to rst and change setup.py to use it.

noahp commented 4 years ago

Hmm yeah, looks like I accidentally jammed a few busted markdown format elements in there, no idea why I did that :facepalm: . I'll merge this and add a CI step to generate the man pages.