[Python-modules-team] Bug#907256: mkdocs: Remaining work items for version 1.0.x in unstable

[Dmitry Shachnev]

Source: python-mkdocs
Version: 1.0.2+dfsg-1

Dear Brian and other developers interested in mkdocs,

I have uploaded mkdocs 1.0.2 to experimental today. But in order to get
it to unstable, the following issues need to be solved:

1) Currently mkdocs bundles Lunr libraries which are not in the preferred
   form of modification. The lunr.js file is generated from smaller JS files
   in [1], and Lunr language files are generated from the third-party data
   files using the build.js script in [2].

   We will need to package Lunr or at least include the missing sources in
   debian/missing-sources.

2) Starting with version 1.0, mkdocs uses external version of highlight.js
   rather than bundling it. For mkdocs' own docs, I am fixing this using
   sed calls in debian/rules. But we need to document how to do that for
   other packages, or maybe write a debhelper addon to do that.

   Note: I tried to convince upstream to switch to Pygments but they are not
   going to do that [3].

3) The new version breaks third-party themes like mkdocs-bootstrap and
   mkdocs-nature. We will need to update those theme packages to their new
   versions simultaneously with mkdocs itself.

   Packages which had symlinks to mkdocs itself or mkdocs-bootstrap files
   (cider-doc and projectile-doc) will also need to be updated as some of
   the symlinks will be dangling with the new version.

I do not have time or willingness to do all of this myself, so I am filing
this bug in case someone is interested and may help.

[1]: https://github.com/olivernn/lunr.js/tree/master/lib
[2]: https://github.com/MihaiValentin/lunr-languages/tree/master/build
[3]: https://github.com/mkdocs/mkdocs/issues/1588

--
Dmitry Shachnev
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://alioth-lists.debian.net/pipermail/python-modules-team/attachments/20180825/48f5f739/attachment.sig>