[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Common problems with Sphinx-generated documentation



lintian4python (>= 0.5) is now able to detect some common problems with Sphinx-generated documentation, which break the search functionality. Please consider fixing your packages! :) Please test your packages before uploading, as there might be other, undetected problems with them. If you are using a WebKit-based browser, please take this into account:
https://bitbucket.org/birkenfeld/sphinx/issue/723/search-broken-in-webkit-based-browsers


1) _sources/ directory (or some files from this directory) is missing.

If the documentation was built with "html_copy_source = True", then (all the files from) the _sources/ directory should be included in the binary package.

Affected packages:
drizzle-doc libjs-mathjax python-argparse-doc python-cogent python-django-feincms-doc python-django-mptt python-kinterbasdb python-mongoengine-doc python-mpi4py-doc python-nibabel-doc python-pymongo-doc python-scrapy-doc python-skimage-doc python-tidylib python-turbogears2-doc renpy-doc tilecache vitables


2) Files in _sources/ are compressed.

Affected packages:
python-alsaaudio python-cairo-dev python-carrot python-django-treebeard-doc python-gevent-doc python-gtkmvc-doc python-jinja2-doc python-mpmath-doc python-tweepy-doc python3-postgresql

Rebuilding against debhelper >= 8.9.5 should fix this problem, as dh_compress doesn't compress them anymore (see bug #637492).


3) Package ships JavaScript code that is incompatible with recent jQuery versions:
Affected packages:
fityk ganeti2 phatch-doc python-alsaaudio python-apsw-doc python-argvalidate python-cairo-dev python-couchdb python-django-treebeard-doc python-gearman python-gtkmvc-doc python-kinterbasdb python-mlpy-doc python-mpmath-doc python-pebl-doc python-reportlab-doc python-tweepy-doc python3-postgresql tilecache vitables

Rebuilding against python-sphinx (>= 1.0.7-4) should fix this problem (see bugs #628642, #625208).

--
Jakub Wilk
Andreas Schuldei <andreas@debian.org>
   python-gevent-doc (U)

Andreas Tille <tille@debian.org>
   python-cogent (U)

Carlo Segre <segre@debian.org>
   fityk

Chris Lamb <lamby@debian.org>
   python-django-treebeard-doc

Dave Beckett <dajobe@debian.org>
   python-cairo-dev (U)

David Paleino <dapal@debian.org>
   python-couchdb
   tilecache (U)

David Watson <dwatson@debian.org>
   python-carrot

Debian Games Team <pkg-games-devel@lists.alioth.debian.org>
   renpy-doc

Debian Ganeti Team <pkg-ganeti-devel@lists.alioth.debian.org>
   ganeti2

Debian GIS Project <pkg-grass-devel@lists.alioth.debian.org>
   tilecache

Debian Med Packaging Team <debian-med-packaging@lists.alioth.debian.org>
   python-cogent

Debian Python Modules Team <python-modules-team@lists.alioth.debian.org>
   python-argparse-doc (U)
   python-argvalidate
   python-cairo-dev
   python-django-feincms-doc (U)
   python-django-mptt (U)
   python-gearman
   python-jinja2-doc (U)
   python-mongoengine-doc (U)
   python-mpmath-doc
   python-pebl-doc
   python-reportlab-doc (U)
   python-scrapy-doc
   python-tidylib (U)
   python-tweepy-doc
   python3-postgresql (U)

Debian QA Group <packages@qa.debian.org>
   python-kinterbasdb

Debian Science Maintainers <debian-science-maintainers@lists.alioth.debian.org>
   vitables

Dmitrijs Ledkovs <dmitrij.ledkov@gmail.com>
   vitables (U)

Emilio Pozuelo Monfort <pochu@debian.org>
   phatch-doc (U)

Federico Ceratto <federico.ceratto@gmail.com>
   python-pymongo-doc

Guido Trotter <ultrotter@debian.org>
   ganeti2 (U)

Ignace Mouzannar <mouzannar@gmail.com>
   python-scrapy-doc (U)

Igor Stroh <jenner@debian.org>
   python-reportlab-doc (U)

Iustin Pop <iustin@debian.org>
   ganeti2 (U)

Janos Guljas <janos@resenje.org>
   python-django-feincms-doc
   python-django-mptt
   python-mongoengine-doc
   python-pymongo-doc (U)
   python-tidylib

Joel Rosdahl <joel@debian.org>
   python-apsw-doc

Julien Jehannet <julien.jehannet@logilab.fr>
   libjs-mathjax

Kartik Mistry <kartik@debian.org>
   python-gtkmvc-doc

Laszlo Boszormenyi (GCS) <gcs@debian.hu>
   python-turbogears2-doc

Matthias Klose <doko@debian.org>
   python-reportlab-doc

Michael Hanke <michael.hanke@gmail.com>
   python-mlpy-doc (U)
   python-mpi4py-doc (U)
   python-nibabel-doc (U)

Miguel Landaeta <miguel@miguel.cc>
   python-tweepy-doc (U)

Miriam Ruiz <little_miry@yahoo.es>
   python-pebl-doc (U)
   renpy-doc (U)

NeuroDebian Team <team@neuro.debian.net>
   python-mlpy-doc
   python-mpi4py-doc
   python-nibabel-doc

Ondrej Certik <ondrej@certik.cz>
   python-mpmath-doc (U)

Oxan van Leeuwen <oxan@oxanvanleeuwen.nl>
   python-gearman (U)

Paul Brossier <piem@debian.org>
   python-alsaaudio

Picca Frédéric-Emmanuel <picca@debian.org>
   vitables (U)

Piotr Ożarowski <piotr@debian.org>
   phatch-doc (U)
   python-jinja2-doc

Python Applications Packaging Team <python-apps-team@lists.alioth.debian.org>
   phatch-doc

Ritesh Raj Sarraf <rrs@debian.org>
   python-argparse-doc

Sandro Tosi <morph@debian.org>
   python-mpmath-doc (U)

Stani M <spe.stani.be@gmail.com>
   phatch-doc (U)

Stefan van der Walt <stefan@sun.ac.za>
   python-skimage-doc

Steffen Moeller <moeller@debian.org>
   python-cogent (U)

Stephan Peijnik <debian@sp.or.at>
   python-argvalidate (U)

Tobias Frost <tobi@coldtobi.de>
   drizzle-doc

Torsten Marek <shlomme@debian.org>
   python-cairo-dev (U)

William Grzybowski <william@agencialivre.com.br>
   python3-postgresql

Yaroslav Halchenko <debian@onerussian.com>
   python-mlpy-doc (U)
   python-mpi4py-doc (U)
   python-nibabel-doc (U)
   python-pebl-doc (U)
   python-skimage-doc (U)

Örjan Persson <orange@fobie.net>
   python-gevent-doc


Reply to: