[cfe-dev] clang-tools-extra sphinx documentation was last updated a month ago

Alexander Kornienko via cfe-dev cfe-dev at lists.llvm.org
Thu Aug 18 04:16:40 PDT 2016


I've recently noticed that files in
http://clang.llvm.org/extra/clang-tidy/checks/ (and the rest of
clang-tools-extra sphinx documents) had last been built on July 18 (by
Sphinx 1.1.3). The rest of clang docs seem to build normally (using Sphinx
1.4.5), which makes me think that the issue might have something to do with
the upgrade of sphinx. I've updated it locally and the issues should be
fixed now in r279049.

The clang-sphinx-docs buildbot was green all this month (e.g.
http://lab.llvm.org:8011/builders/clang-sphinx-docs/builds/15762), but I
don't know 1. whether it builds clang-tools-extra docs and 2. which version
of Sphinx (and Pygments) it uses.

So the questions:
  1. Tanya, can we make the process of building docs for llvm.org more
transparent? In the form of a status dashboard, logs of the last build or
e-mail notifications, for example.
  2. Dmitri, can you update Sphinx on the clang-sphinx-docs buildbot to the
same version that is used to build docs for llvm.org?
  3. Dmitri, could you include clang-tools-extra docs to the build steps on
the clang-sphinx-docs buildbot?
  4. Can we provide a better coordination between documentation format and
tools versions? Possible options are:
    a. Move in the direction of hermetic documentation builds. For
instance, put a private copy of Sphinx to LLVM sources somewhere in
llvm/utils/ and fix the documentation files when updating Sphinx.
    b. Strictly require a certain version of Sphinx when building
documentation. Only works if there is a sane and reliable way to get a
specific version of the package on every platform.
    c. At least, coordinate Sphinx updates on all docs buildbots and
whatever is used to build docs for llvm.org.


-- Alex
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20160818/bc4580b9/attachment.html>

More information about the cfe-dev mailing list