On Sun, Jul 07, 2024 at 10:32:18AM +0200, Carsten Schoenert wrote:
> The build itself is no problem I guess (the autopkgtest will need
> further adjustments too), but I see issues if I'm trying
> to browse through the contents of the installed python-mkdocs-doc package.
> 
> These issues so far are broken linking, e.g. on the start page
> 
> file:///usr/share/doc/mkdocs/html/index.html
> 
> the first a href element with the name 'introductory tutorial' is
> pointing correctly to 
> 
> file:///usr/share/doc/mkdocs/html/getting-started.html
> 
> but the button beneath "Getting Started" is linked to
> 
> file:///usr/share/doc/mkdocs/html/getting-started
> 
> The same is happen to other buttons but also to a href elements all over
> the content.

This isn't a regression, though - it's the same in the current version.
Output that's generated from normal Markdown is fine, but the cases you
point to come from input that includes embedded HTML.  mkdocs documents
this behaviour:

  https://www.mkdocs.org/user-guide/writing-your-docs/#linking-from-raw-html

"However, as all raw HTML is ignored by the Markdown parser, MkDocs is
not able to validate or convert links contained in raw HTML. When
including internal links within raw HTML, you will need to manually
format the link appropriately for the rendered document."

So I think the right fix in this case is just to patch the input, and it
shouldn't cause any more of a problem for other packages using mkdocs
than it already does.

I'll see if I can merge your work this week and get a release out.

-- 
Colin Watson (he/him)                              [cjwat...@debian.org]

Reply via email to