Skip Menu |

This queue is for tickets about the Pod-POM-View-Restructured CPAN distribution.

Report information
The Basics
Id: 124710
Status: resolved
Priority: 0/
Queue: Pod-POM-View-Restructured

People
Owner: alexm [...] cpan.org
Requestors: dilyan.palauzov [...] aegee.org
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: 0.01
Fixed in: 0.04



Subject: Pod-POM-View-Restructured-0.03 -> view_pod -> ".. highlight:: perl\n\n"
Date: Wed, 7 Mar 2018 13:48:41 +0100
To: Alex Muntada <alexm [...] cpan.org>
From: Дилян Палаузов <dilyan.palauzov [...] aegee.org>
Hello, Pod-POM-View-Restructured-0.03 has sub view_pod { my ($self, $node) = @_; my $content = ".. highlight:: perl\n\n"; return $content . $node->content()->present($self); } which inserts ".. highlight:: perl\n\n" in the final document. Is there anyway to disable inserting the highlight snippet by pod2rst? When Sphinx is used to generate a single-html page with the documentation the "..highlight: perl " line changes the code for all subsequent :: places to perl, instead of the default and, while this is incorrect, the perl pygments lexer is not capable to render any text without throwing exception. All in all for a single-html documentation the highlight::perl messes up the remaining documentation. As Pod-POM-View-Restructured inserts anyway "..code-block:: perl" on the relevant places I see in fact no need for the highlight::perl part. Somehow I cannot login at https://rt.cpan.org , hence per email. Regards Dilian
Subject: Re: [rt.cpan.org #124710] Pod-POM-View-Restructured-0.03 -> view_pod -> ".. highlight:: perl\n\n"
Date: Wed, 7 Mar 2018 15:19:14 +0100
To: Дилян Палаузов via RT <bug-Pod-POM-View-Restructured [...] rt.cpan.org>
From: Alex Muntada <alexm [...] cpan.org>
Hi Дилян, Show quoted text
> Is there anyway to disable inserting the highlight snippet by > pod2rst?
The first thing that comes to mind is monkey-patching that method in a copy of pod2rst, but let's see if we can find a way to avoid that. Show quoted text
> When Sphinx is used to generate a single-html page with the > documentation the "..highlight: perl " line changes the code > for all subsequent :: places to perl, instead of the default > and, while this is incorrect, the perl pygments lexer is not > capable to render any text without throwing exception. All in > all for a single-html documentation the highlight::perl messes > up the remaining documentation.
Could you provide a simple example I can work with? Show quoted text
> As Pod-POM-View-Restructured inserts anyway "..code-block:: > perl" on the relevant places I see in fact no need for the > highlight::perl part.
Show quoted text
> Somehow I cannot login at https://rt.cpan.org , hence per email.
No problem, I just bounced your mail to bug-$module@rt.cpan.org and it worked :) I'll add the bug contact address to the main POD file to avoid confusion. Thanks a lot! Alex
Download signature.asc
application/pgp-signature 833b

Message body not shown because it is not plain text.

Subject: Re: [rt.cpan.org #124710] Pod-POM-View-Restructured-0.03 -> view_pod -> ".. highlight:: perl\n\n"
Date: Wed, 7 Mar 2018 15:37:48 +0100
To: bug-Pod-POM-View-Restructured [...] rt.cpan.org
From: Дилян Палаузов <dilyan.palauzov [...] aegee.org>
Hello, I experienced the problem when compiling the documentation of cyrus imap: pip install gitpython git clone https://github.com/cyrusimap/cyrus-imapd cd cyrus-imapd/ ./configure cd docsrc make signlehtml This prints: writing... /git/cyrus-imapd.master/docsrc/index.rst:183: WARNING: Could not lex literal_block as "perl". Highlighting skipped. /git/cyrus-imapd.master/docsrc/index.rst:240: WARNING: Could not lex literal_block as "perl". Highlighting skipped. /git/cyrus-imapd.master/docsrc/index.rst:64: WARNING: Could not lex literal_block as "perl". Highlighting skipped. /git/cyrus-imapd.master/docsrc/index.rst:77: WARNING: Could not lex literal_block as "perl". Highlighting skipped. /git/cyrus-imapd.master/docsrc/index.rst:56: WARNING: Could not lex literal_block as "perl". Highlighting skipped. /git/cyrus-imapd.master/docsrc/index.rst:54: WARNING: Could not lex literal_block as "perl". Highlighting skipped. /git/cyrus-imapd.master/docsrc/index.rst:62: WARNING: Could not lex literal_block as "perl". Highlighting skipped. /git/cyrus-imapd.master/docsrc/index.rst:182: WARNING: Could not lex literal_block as "perl". Highlighting skipped. done e.g. because in docsrc/imap/reference/admin/nntp.rst:Email clients lines 135-137 the pygments-perl lexer complains about the $ token. The files imap/reference/manpages/usercommands/sieveshell.rst and imap/reference/manpages/systemcommands/cyradm.rst contain .. highlight:: perl Unfortunately I have no simpler example. Regards Diluian On 03/07/18 15:19, Alex Muntada via RT wrote: Show quoted text
> <URL: https://rt.cpan.org/Ticket/Display.html?id=124710 > > > Hi Дилян, >
>> Is there anyway to disable inserting the highlight snippet by >> pod2rst?
> > The first thing that comes to mind is monkey-patching that method > in a copy of pod2rst, but let's see if we can find a way to avoid > that. >
>> When Sphinx is used to generate a single-html page with the >> documentation the "..highlight: perl " line changes the code >> for all subsequent :: places to perl, instead of the default >> and, while this is incorrect, the perl pygments lexer is not >> capable to render any text without throwing exception. All in >> all for a single-html documentation the highlight::perl messes >> up the remaining documentation.
> > Could you provide a simple example I can work with? >
>> As Pod-POM-View-Restructured inserts anyway "..code-block:: >> perl" on the relevant places I see in fact no need for the >> highlight::perl part.
>
>> Somehow I cannot login at https://rt.cpan.org , hence per email.
> > No problem, I just bounced your mail to bug-$module@rt.cpan.org > and it worked :) > > I'll add the bug contact address to the main POD file to avoid > confusion. > > Thanks a lot! > Alex > >
Subject: Re: [rt.cpan.org #124710] Pod-POM-View-Restructured-0.03 -> view_pod -> ".. highlight:: perl\n\n"
Date: Wed, 7 Mar 2018 19:12:36 +0100
To: Дилян Палаузов via RT <bug-Pod-POM-View-Restructured [...] rt.cpan.org>
From: Alex Muntada <alexm [...] cpan.org>
Hi Дилян, Show quoted text
> I experienced the problem when compiling the documentation of > cyrus imap:
This will help me understand the issue better, thanks. Show quoted text
> Unfortunately I have no simpler example.
Don't worry, the example you provided seems good enough. Cheers, Alex
Subject: Re: [rt.cpan.org #124710] Pod-POM-View-Restructured-0.03 -> view_pod -> ".. highlight:: perl\n\n"
Date: Mon, 12 Mar 2018 22:41:33 +0100
To: Дилян Палаузов via RT <bug-Pod-POM-View-Restructured [...] rt.cpan.org>
From: Alex Muntada <alexm [...] cpan.org>
Hi Дилян, Show quoted text
> I experienced the problem when compiling the documentation of > cyrus imap: > > pip install gitpython > git clone https://github.com/cyrusimap/cyrus-imapd > cd cyrus-imapd/ > ./configure > cd docsrc > make signlehtml
There's a missing step "make init" that is needed to create imapd.conf.rst. Maybe it should be added as a dependency on the simplehtml target, I'm not sure why it isn't. Before I found that, I tried with both python2 and python3 in Debian unstable and I didn't get the error you mentioned below (I got many others regarding missing imapd.conf.rst). Show quoted text
> This prints: > > writing... /git/cyrus-imapd.master/docsrc/index.rst:183: WARNING: Could not lex literal_block as "perl". Highlighting skipped. > /git/cyrus-imapd.master/docsrc/index.rst:240: WARNING: Could not lex literal_block as "perl". Highlighting skipped. > /git/cyrus-imapd.master/docsrc/index.rst:64: WARNING: Could not lex literal_block as "perl". Highlighting skipped. > /git/cyrus-imapd.master/docsrc/index.rst:77: WARNING: Could not lex literal_block as "perl". Highlighting skipped. > /git/cyrus-imapd.master/docsrc/index.rst:56: WARNING: Could not lex literal_block as "perl". Highlighting skipped. > /git/cyrus-imapd.master/docsrc/index.rst:54: WARNING: Could not lex literal_block as "perl". Highlighting skipped. > /git/cyrus-imapd.master/docsrc/index.rst:62: WARNING: Could not lex literal_block as "perl". Highlighting skipped. > /git/cyrus-imapd.master/docsrc/index.rst:182: WARNING: Could not lex literal_block as "perl". Highlighting skipped. > done
I confirm that I get the same results with both versions and I see in http://www.sphinx-doc.org/en/stable/markup/code.html that highlight isn't needed when code-block is used, so I'll remove highlight from view_pod method as you suggest. Thanks! Alex
Subject: Re: [rt.cpan.org #124710] Pod-POM-View-Restructured-0.03 -> view_pod -> ".. highlight:: perl\n\n"
Date: Wed, 21 Mar 2018 18:13:21 +0100
To: bug-Pod-POM-View-Restructured [...] rt.cpan.org
From: Дилян Палаузов <dilyan.palauzov [...] aegee.org>
Hello, when will be there a new release of Pod-POM-View-Restructured with the change included? Kind regards Dilyan Palauzov On 03/12/18 22:41, Alex Muntada via RT wrote: Show quoted text
> <URL: https://rt.cpan.org/Ticket/Display.html?id=124710 > > > Hi Дилян, >
>> I experienced the problem when compiling the documentation of >> cyrus imap: >> >> pip install gitpython >> git clone https://github.com/cyrusimap/cyrus-imapd >> cd cyrus-imapd/ >> ./configure >> cd docsrc >> make signlehtml
> > There's a missing step "make init" that is needed to create > imapd.conf.rst. Maybe it should be added as a dependency on > the simplehtml target, I'm not sure why it isn't. > > Before I found that, I tried with both python2 and python3 > in Debian unstable and I didn't get the error you mentioned > below (I got many others regarding missing imapd.conf.rst). >
>> This prints: >> >> writing... /git/cyrus-imapd.master/docsrc/index.rst:183: WARNING: Could not lex literal_block as "perl". Highlighting skipped. >> /git/cyrus-imapd.master/docsrc/index.rst:240: WARNING: Could not lex literal_block as "perl". Highlighting skipped. >> /git/cyrus-imapd.master/docsrc/index.rst:64: WARNING: Could not lex literal_block as "perl". Highlighting skipped. >> /git/cyrus-imapd.master/docsrc/index.rst:77: WARNING: Could not lex literal_block as "perl". Highlighting skipped. >> /git/cyrus-imapd.master/docsrc/index.rst:56: WARNING: Could not lex literal_block as "perl". Highlighting skipped. >> /git/cyrus-imapd.master/docsrc/index.rst:54: WARNING: Could not lex literal_block as "perl". Highlighting skipped. >> /git/cyrus-imapd.master/docsrc/index.rst:62: WARNING: Could not lex literal_block as "perl". Highlighting skipped. >> /git/cyrus-imapd.master/docsrc/index.rst:182: WARNING: Could not lex literal_block as "perl". Highlighting skipped. >> done
> > I confirm that I get the same results with both versions and I > see in http://www.sphinx-doc.org/en/stable/markup/code.html that > highlight isn't needed when code-block is used, so I'll remove > highlight from view_pod method as you suggest. > > Thanks! > Alex >
Subject: Re: [rt.cpan.org #124710] Pod-POM-View-Restructured-0.03 -> view_pod -> ".. highlight:: perl\n\n"
Date: Sat, 7 Apr 2018 18:48:29 +0200
To: Дилян Палаузов via RT <bug-Pod-POM-View-Restructured [...] rt.cpan.org>
From: Alex Muntada <alexm [...] cpan.org>
Дилян Палаузов via RT: Show quoted text
> when will be there a new release of Pod-POM-View-Restructured > with the change included?
I'm working on it and I hope I'll be able to release a new version this weekend. Cheers, Alex