[Python-modules-team] Bug#916621: djangorestframework’s mkdocs theme is incompatible with mkdocs 1.0

[Dmitry Shachnev]

Source: djangorestframework
Version: 3.8.2-2
Severity: important

Dear djangorestframework maintainers,

The custom mkdocs theme that djangorestframwork uses is incompatible with
mkdocs 1.0 which I am going to upload.

In fact, it is already visually broken with mkdocs 0.17, see [1]. But with
1.0, there will be more issues:

- {{ base_url }} can no longer be used in templates;
- URLs like {{ page.next_page.url }} need to have |url filter;
- Some mkdocs.yml options need to be changed: theme_dir and pages
  need to be changed to theme.custom_dir and nav.

Upstream seems to have no interest in porting the theme to newer mkdocs
versions. They just depend on mkdocs 0.16 for now.

Will you mind if I update the packaging and change the theme from custom
to default?

That will also give me the ability to symlink the JS/CSS/fonts files to
the packaged versions (the custom theme uses Bootstrap 2 which is removed
from Debian, the default theme uses Bootstrap 3 and will use Bootstrap 4
in the next release).

[1]: https://github.com/encode/django-rest-framework/issues/5945

--
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/20181216/0c69779d/attachment-0001.sig>