diff options
| author | Palica <palica+gitlab@liguros.net> | 2020-06-23 22:35:08 +0200 |
|---|---|---|
| committer | Palica <palica+gitlab@liguros.net> | 2020-06-23 22:35:08 +0200 |
| commit | ecdac123787b96ce6649f0f91da12ea6458cc2b1 (patch) | |
| tree | b89c74d9e6fe6e8aebc4c77bcbeb4ab73214127d /dev-python/m2r | |
| parent | 1be72aa41cf41dedadeecf59dca9f01de6381f5e (diff) | |
| download | baldeagleos-repo-ecdac123787b96ce6649f0f91da12ea6458cc2b1.tar.gz baldeagleos-repo-ecdac123787b96ce6649f0f91da12ea6458cc2b1.tar.xz baldeagleos-repo-ecdac123787b96ce6649f0f91da12ea6458cc2b1.zip | |
Updating liguros repo
Diffstat (limited to 'dev-python/m2r')
| -rw-r--r-- | dev-python/m2r/Manifest | 1 | ||||
| -rw-r--r-- | dev-python/m2r/files/m2r-0.2.1-tests-network.patch | 28 | ||||
| -rw-r--r-- | dev-python/m2r/files/m2r-0.2.1-tests.patch | 65 | ||||
| -rw-r--r-- | dev-python/m2r/files/m2r-0.2.1-upstream-fix.patch | 23 | ||||
| -rw-r--r-- | dev-python/m2r/files/m2r.1 | 515 | ||||
| -rw-r--r-- | dev-python/m2r/files/test.md | 5 | ||||
| -rw-r--r-- | dev-python/m2r/files/test.rst | 8 | ||||
| -rw-r--r-- | dev-python/m2r/m2r-0.2.1.ebuild | 53 | ||||
| -rw-r--r-- | dev-python/m2r/metadata.xml | 17 |
9 files changed, 715 insertions, 0 deletions
diff --git a/dev-python/m2r/Manifest b/dev-python/m2r/Manifest new file mode 100644 index 000000000000..0552e9342a44 --- /dev/null +++ b/dev-python/m2r/Manifest @@ -0,0 +1 @@ +DIST m2r-0.2.1.tar.gz 24455 BLAKE2B 42ec5a919301b6dee2b345a5eca9e62a1bd44186fb61dbd8cc9de6cacc34821e912f242355cc7368b755f923a433353cfa567afc480e9b8c63bf209ff9d3c624 SHA512 847f04538ee52f0b0a88cee9474ed889e8114a3a7b1fb221cdaa867ab70ca52f517250f2c8bbf795ae598c7b6614e6d03d9f6f05b7e3d56fb8087d63eb52f1bc diff --git a/dev-python/m2r/files/m2r-0.2.1-tests-network.patch b/dev-python/m2r/files/m2r-0.2.1-tests-network.patch new file mode 100644 index 000000000000..74f3a0ca7a6a --- /dev/null +++ b/dev-python/m2r/files/m2r-0.2.1-tests-network.patch @@ -0,0 +1,28 @@ +diff --git a/tests/test_cli.py b/tests/test_cli.py +index e53e209..4dff652 100644 +--- a/tests/test_cli.py ++++ b/tests/test_cli.py +@@ -5,6 +5,7 @@ from __future__ import print_function, unicode_literals + + import sys + import os ++import unittest + from os import path + from copy import copy + from unittest import TestCase +@@ -127,6 +128,7 @@ class TestConvert(TestCase): + self.assertIn('__content__', m.call_args[0][0]) + self.assertNotIn('**content**', m.call_args[0][0]) + ++ @unittest.skip("needs internet access") + def test_anonymous_reference_option(self): + sys.argv = [ + sys.argv[0], '--anonymous-references', '--dry-run', test_md] +@@ -135,6 +137,7 @@ class TestConvert(TestCase): + self.assertIn("`A link to GitHub <http://github.com/>`__", + m.call_args[0][0]) + ++ @unittest.skip("test seems to be broken") + def test_disable_inline_math(self): + sys.argv = [ + sys.argv[0], '--disable-inline-math', '--dry-run', test_md] diff --git a/dev-python/m2r/files/m2r-0.2.1-tests.patch b/dev-python/m2r/files/m2r-0.2.1-tests.patch new file mode 100644 index 000000000000..9c70bbc5b49d --- /dev/null +++ b/dev-python/m2r/files/m2r-0.2.1-tests.patch @@ -0,0 +1,65 @@ +From 77968c4574cb121737a2017b936870603664be39 Mon Sep 17 00:00:00 2001 +From: miyakogi <miyako.dev@gmail.com> +Date: Tue, 4 Jun 2019 19:13:26 +0900 +Subject: [PATCH] Fix test + +--- + tests/test_renderer.py | 12 ++++++------ + 1 file changed, 6 insertions(+), 6 deletions(-) + +diff --git a/tests/test_renderer.py b/tests/test_renderer.py +index 5c6f915..4c7ebba 100644 +--- a/tests/test_renderer.py ++++ b/tests/test_renderer.py +@@ -43,6 +43,7 @@ def check_rst(self, rst): + class TestBasic(RendererTestBase): + def test_fail_rst(self): + with self.assertRaises(AssertionError): ++ # This check should be failed and report warning + self.check_rst('```') + + def test_simple_paragraph(self): +@@ -709,7 +710,6 @@ def test_footnote(self): + '', + '.. [#a] note rst', # one empty line inserted... + '', +- '', + '.. [#fn-1] note 1', + '.. [#fn-2] note 2', + '.. [#fn-ref] note ref', +@@ -719,22 +719,22 @@ def test_footnote(self): + def test_sphinx_ref(self): + src = 'This is a sphinx [ref]_ global ref.\n\n.. [ref] ref text' + out = self.conv(src) +- self.assertEqual(out, '\n' + src + '\n') ++ self.assertEqual(out, '\n' + src) + + + class TestDirective(RendererTestBase): + def test_comment_oneline(self): + src = '.. a' + out = self.conv(src) +- self.assertEqual(out, '\n.. a\n') ++ self.assertEqual(out, '\n.. a') + + def test_comment_indented(self): + src = ' .. a' + out = self.conv(src) +- self.assertEqual(out, '\n .. a\n') ++ self.assertEqual(out, '\n .. a') + + def test_comment_newline(self): +- src = '..\n\n comment\nnewline' ++ src = '..\n\n comment\n\nnewline' + out = self.conv(src) + self.assertEqual(out, '\n..\n\n comment\n\nnewline\n') + +@@ -748,7 +748,7 @@ def test_comment_multiline(self): + '\n\n') + src = comment + '`eoc`' + out = self.conv(src) +- self.assertEqual(out, '\n' + comment + '\n``eoc``\n') ++ self.assertEqual(out, '\n' + comment + '``eoc``\n') + + + class TestRestCode(RendererTestBase): diff --git a/dev-python/m2r/files/m2r-0.2.1-upstream-fix.patch b/dev-python/m2r/files/m2r-0.2.1-upstream-fix.patch new file mode 100644 index 000000000000..7060c33e78dd --- /dev/null +++ b/dev-python/m2r/files/m2r-0.2.1-upstream-fix.patch @@ -0,0 +1,23 @@ +From c78db2aa91787df6973ad6400208707c7ecf4b12 Mon Sep 17 00:00:00 2001 +From: "Ethan \"Soron\" Kaminski" <ethan.kaminski@gmail.com> +Date: Thu, 25 Apr 2019 12:56:14 +0800 +Subject: [PATCH] Remove a trailing newline after `.rst` directives (fix issue + #35) + +--- + m2r.py | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + +diff --git a/m2r.py b/m2r.py +index 897338d..74c8c98 100644 +--- a/m2r.py ++++ b/m2r.py +@@ -507,7 +507,7 @@ def eol_literal_marker(self, marker): + return marker + + def directive(self, text): +- return '\n' + text + '\n' ++ return '\n' + text + + def rest_code_block(self): + return '\n\n' diff --git a/dev-python/m2r/files/m2r.1 b/dev-python/m2r/files/m2r.1 new file mode 100644 index 000000000000..1a6c10b48a90 --- /dev/null +++ b/dev-python/m2r/files/m2r.1 @@ -0,0 +1,515 @@ +.\" Man page generated from reStructuredText. +. +.TH "M2R" "1" "Mar 30, 2017" "0.1.5" "M2R" +.SH NAME +m2r \- M2R Documentation +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +\fI\%PyPI\fP\fI\%PyPI version\fP\fI\%Build Status\fP\fI\%codecov\fP +.sp +.ce +---- + +.ce 0 +.sp +.sp +M2R converts a markdown file including reST markups to a valid reST format. +.SH WHY ANOTHER CONVERTER? +.sp +I wanted to write sphinx document in markdown, since it\(aqs widely used now and +easy to write code blocks and lists. However, converters using pandoc or +recommonmark do not support many reST markups and sphinx extensions. For +example, reST\(aqs reference link like \fBsee \(garef\(ga_\fP (this is very convenient in +long document in which same link appears multiple times) will be converted to +a code block in HTML like \fBsee <code>ref</code>_\fP, which is not expected. +.SH FEATURES +.INDENT 0.0 +.IP \(bu 2 +Basic markdown and some extensions (see below) +.INDENT 2.0 +.IP \(bu 2 +inline/block\-level raw html +.IP \(bu 2 +fenced\-code block +.IP \(bu 2 +tables +.IP \(bu 2 +footnotes (\fB[^1]\fP) +.UNINDENT +.IP \(bu 2 +Inline\- and Block\-level reST markups +.INDENT 2.0 +.IP \(bu 2 +single\- and multi\-line directives (\fB\&.. directive::\fP) +.IP \(bu 2 +inline\-roles (\fB:code:\(gaprint(1)\(ga ...\fP) +.IP \(bu 2 +ref\-link (\fBsee \(garef\(ga_\fP) +.IP \(bu 2 +footnotes (\fB[#fn]_\fP) +.IP \(bu 2 +math extension inspired by \fI\%recommonmark\fP +.UNINDENT +.IP \(bu 2 +Sphinx extension +.INDENT 2.0 +.IP \(bu 2 +add markdown support for sphinx +.IP \(bu 2 +\fBmdinclude\fP directive to include markdown from md or reST files +.UNINDENT +.UNINDENT +.SH INSTALLATION +.sp +Python 2.7 or Python 3.3+ is required. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +pip install m2r +.ft P +.fi +.UNINDENT +.UNINDENT +.SH USAGE +.SS Command Line +.sp +\fBm2r\fP command converts markdown file to reST format. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +m2r your_document.md [your_document2.md ...] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Then you will find \fByour_document.rst\fP in the same directory. +.SS Programmatic Use +.sp +Instantiate \fBM2R\fP class and call with markdown text. Then it will return converted text. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +from m2r import M2R +m2r = M2R() +rest = m2r(\(aq# Title\en\enSentence.\(aq) +print(rest) +# Title +# ===== +# +# Sentence. +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Or, use \fBparse_from_file\fP function to load markdown file and obtain converted text. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +from m2r import parse_from_file +output = parse_from_file(\(aqmarkdown_file.md\(aq) +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +This is an example of setup.py to write README in markdown, and publish it to PyPI as reST format. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +readme_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), \(aqREADME.md\(aq) +try: + from m2r import parse_from_file + readme = parse_from_file(readme_file) +except ImportError: + # m2r may not be installed in user environment + with open(readme_file) as f: + readme = f.read() +setup( + ..., + long_description=readme, + ..., +) +.ft P +.fi +.UNINDENT +.UNINDENT +.SS Sphinx Integration +.sp +In your conf.py, add the following lines. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +extensions = [ + ..., + \(aqm2r\(aq, +] + +# source_suffix = \(aq.rst\(aq +source_suffix = [\(aq.rst\(aq, \(aq.md\(aq] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Write index.md and run \fBmake html\fP\&. +.sp +When \fBm2r\fP extension is enabled on sphinx and \fB\&.md\fP file is loaded, m2r +converts to reST and pass to sphinx, not making new \fB\&.rst\fP file. +.SS mdinclude directive +.sp +Like \fB\&.. include:: file\fP directive, \fB\&.. mdinclude:: file\fP directive inserts +markdown file at the line. +.sp +Note: do not use \fB\&.. include:: file\fP directive to include markdown file even if +in the markdown file, please use \fB\&.. mdinclude:: file\fP instead. +.SH RESTRICTIONS +.INDENT 0.0 +.IP \(bu 2 +In the reST\(aqs directives, markdown is not available. Please write in reST. +.IP \(bu 2 +Column alignment of tables is not supported. (reST does not support this feature) +.IP \(bu 2 +Heading with overline\-and\-underline is not supported. +.INDENT 2.0 +.IP \(bu 2 +Heading with underline is OK +.UNINDENT +.UNINDENT +.sp +If you find any bug or unexpected behaviour, please report it to +\fI\%Issues\fP\&. +.SH EXAMPLE +.sp +See \fI\%example document\fP and \fI\%its +source code\fP\&. +.sp +I\(aqm using m2r for writing user guide of \fI\%WDOM\fP\&. +So you can see it as another example. Its \fI\%HTML is +here\fP, and \fI\%its +source code is here\fP\&. +.SH ACKNOWLEDGEMENT +.sp +m2r is written as an extension of +\fI\%mistune\fP, which is highly extensible +pure\-python markdown parser. +Without the mistune, I couldn\(aqt write this. Thank you! +.SH LICENCE +.sp +\fI\%MIT\fP +.SH CONTENTS +.SS Example +.sp +This page is written in mixed markdown and reST. +Source code is \fI\%here\fP\&. +.SS Basic Markups (inline) +.sp +A \fBstrong\fP, \fIemphasis\fP, , \fBcode with single\-backtick\fP, +\fBcode with two\-backticks\fP, , +\fBreST\(aqs code role\fP, and delete. +.SS Link +.sp +Auto link to \fI\%http://example.com/\fP\&. +.sp +Link to \fI\%example.com\fP in markdown. +.sp +Link to \fI\%example.com\fP in reST. +.sp +Link to \fI\%example\fP in reST_ref. +.SS Basic Markups (block) +.sp +This is a simple sentence. +.nf +sentence with +newlines +(reST) +.fi +.sp +.sp +Sentence with +hard\-wrap (markdown, trailing two spaces) +.INDENT 0.0 +.INDENT 3.5 +block quote +second line +.INDENT 0.0 +.INDENT 3.5 +nested quote +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT + +.sp +.ce +---- + +.ce 0 +.sp +.INDENT 0.0 +.INDENT 3.5 +Block quote after raw\-html directive +.UNINDENT +.UNINDENT +.SS List +.SS Unordered list +.INDENT 0.0 +.IP \(bu 2 +unordered list +new line +.IP \(bu 2 +next item +.INDENT 2.0 +.IP \(bu 2 +nested list +with new line +.IP \(bu 2 +nested list item 2 +.UNINDENT +.IP \(bu 2 +original depth +.INDENT 2.0 +.IP 1. 3 +ordered list item +.IP 2. 3 +second +with new line +.UNINDENT +.IP \(bu 2 +original depth again +.UNINDENT +.SS Ordered list +.INDENT 0.0 +.IP 1. 3 +ordered list +in new line +.IP 2. 3 +second item +.INDENT 3.0 +.IP \(bu 2 +nested unordered list +.IP \(bu 2 +second item +with new line +.UNINDENT +.IP 3. 3 +original depth +.INDENT 3.0 +.IP 1. 3 +nested ordered list +with new line +.IP 2. 3 +again +.UNINDENT +.IP 4. 3 +original depth again +.UNINDENT +.SS Code Block +.sp +Simple, indented code block +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +pip install sphinx +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Code block with triple backticks and language. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +def a(n: int) \-> None: + for i in range(n): + print(i) +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Triple\-tildes (\fB~~~\fP) are also available. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +def a(n: int) \-> None: + for i in range(n): + print(i) +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Here is reST style code block. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +if True: + print(\(aq\en\(aq) +.ft P +.fi +.UNINDENT +.UNINDENT +.SS Extensions +.SS Table (Markdown\-Style) +.sp +(cell\-alignment is not supported currently) +.TS +center; +|l|l|l|. +_ +T{ +Table Header 1 +T} T{ +Table Header 2 +T} T{ +Table Header 3 +T} +_ +T{ +normal +T} T{ +\fIitalic\fP +T} T{ +\fBbold\fP +T} +_ +T{ +\fBcode\fP +T} T{ +T} T{ +T} +_ +.TE +.SS Math +.sp +This is E = mc^2 inline math. +.sp +The below is math\-block (markdown\-style). +.sp +.ce + +.ce 0 +.sp +The below is reST\-style math\-block. +.sp +.ce + +.ce 0 +.SS Footnote +.sp +Footnote[2] and footnote[3] with markdown. +.sp +Footnote with reST[1]\&. +.sp + +.IP [1] 5 +reST footnote +.IP [2] 5 +footnote 1 +.IP [3] 5 +footnote key +.SS Change Log +.SS Version 0.2 +.sp +(next version) +.SS Version 0.1.5 (2016\-06\-21) +.INDENT 0.0 +.IP \(bu 2 +Support multiple backticks in inline code, like: +.UNINDENT +.SS Version 0.1.4 (2016\-06\-08) +.INDENT 0.0 +.IP \(bu 2 +Support indented directives/reST\-comments +.IP \(bu 2 +Support role\-name after backticks (\fB\(gatext\(ga:role: style\fP) +.UNINDENT +.SS Version 0.1.3 (2016\-06\-02) +.INDENT 0.0 +.IP \(bu 2 +Remove extra escaped\-spaces (\(aq\(aq) +.INDENT 2.0 +.IP \(bu 2 +before and after normal spaces +.IP \(bu 2 +at the beginning of lines +.IP \(bu 2 +before dots +.UNINDENT +.UNINDENT +.SS Version 0.1.2 (2016\-06\-01) +.INDENT 0.0 +.IP \(bu 2 +Add reST\(aqs \fB::\fP marker support +.IP \(bu 2 +Add options to disable emphasis by underscore (\fB_\fP or \fB__\fP) +.UNINDENT +.SS Version 0.1.1 (2016\-05\-30) +.INDENT 0.0 +.IP \(bu 2 +Fix Bug: when code or link is placed at the end of line, spaces to the next word is disappeared +.UNINDENT +.SS Version 0.1 (2016\-05\-30) +.sp +First public release. +.INDENT 0.0 +.IP \(bu 2 +genindex +.IP \(bu 2 +modindex +.IP \(bu 2 +search +.UNINDENT +.SH AUTHOR +Hiroyuki Takagi +.SH COPYRIGHT +2016, Hiroyuki Takagi +.\" Generated by docutils manpage writer. +. diff --git a/dev-python/m2r/files/test.md b/dev-python/m2r/files/test.md new file mode 100644 index 000000000000..e54ac950e527 --- /dev/null +++ b/dev-python/m2r/files/test.md @@ -0,0 +1,5 @@ +# Title + +## SubTitle + +__content__ diff --git a/dev-python/m2r/files/test.rst b/dev-python/m2r/files/test.rst new file mode 100644 index 000000000000..f45558879567 --- /dev/null +++ b/dev-python/m2r/files/test.rst @@ -0,0 +1,8 @@ + +Title +===== + +SubTitle +-------- + +**content** diff --git a/dev-python/m2r/m2r-0.2.1.ebuild b/dev-python/m2r/m2r-0.2.1.ebuild new file mode 100644 index 000000000000..524fde1d1afb --- /dev/null +++ b/dev-python/m2r/m2r-0.2.1.ebuild @@ -0,0 +1,53 @@ +# Copyright 1999-2020 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI=7 +PYTHON_COMPAT=( python2_7 python3_{6..9} pypy3 ) +DISTUTILS_USE_SETUPTOOLS=rdepend + +inherit distutils-r1 + +DESCRIPTION="Markdown to reStructuredText converter" +HOMEPAGE="https://github.com/miyakogi/m2r https://pypi.org/project/m2r/" +SRC_URI="https://github.com/miyakogi/m2r/archive/v${PV}.tar.gz -> ${P}.tar.gz" + +LICENSE="MIT" +SLOT="0" +KEYWORDS="~alpha amd64 arm arm64 hppa ~ia64 ppc ppc64 s390 sparc x86" +IUSE="test" + +RDEPEND=" + dev-python/docutils[${PYTHON_USEDEP}] + <dev-python/mistune-2.0[${PYTHON_USEDEP}] +" +BDEPEND=" + test? ( + dev-python/pygments[${PYTHON_USEDEP}] + $(python_gen_cond_dep 'dev-python/mock[${PYTHON_USEDEP}]' python2_7) ) + ${RDEPEND} +" + +PATCHES=( + # pulled from upstream git + "${FILESDIR}/m2r-0.2.1-upstream-fix.patch" + "${FILESDIR}/m2r-0.2.1-tests.patch" + # skip tests that need internet + "${FILESDIR}/m2r-0.2.1-tests-network.patch" +) + +distutils_enable_tests pytest + +python_prepare_all() { + # fix a Q/A violation, trying to install the tests as an independant package + sed -e "s/packages=\['tests'\],/packages=[],/" -i setup.py + # add missing test files + cp "${FILESDIR}/"test.md tests/ || die + cp "${FILESDIR}/"test.rst tests/ || die + cp "${FILESDIR}/"m2r.1 "${S}" || die + distutils-r1_python_prepare_all +} + +python_install_all() { + distutils-r1_python_install_all + doman m2r.1 +} diff --git a/dev-python/m2r/metadata.xml b/dev-python/m2r/metadata.xml new file mode 100644 index 000000000000..e3bb66125064 --- /dev/null +++ b/dev-python/m2r/metadata.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> +<pkgmetadata> + <maintainer type="project"> + <email>python@gentoo.org</email> + <name>Python</name> + </maintainer> + <upstream> + <maintainer> + <email>miyako.dev@gmail.com</email> + <name>Hiroyuki Takagi</name> + </maintainer> + <remote-id type="pypi">m2r</remote-id> + <remote-id type="github">miyakogi/m2r</remote-id> + </upstream> + <origin>gentoo-staging</origin> +</pkgmetadata> |
