Re: [PATCH 00/10] Documentation/Sphinx

From: Jani Nikula
Date: Sun May 29 2016 - 16:33:39 EST


On Fri, 20 May 2016, Jani Nikula <jani.nikula@xxxxxxxxx> wrote:
> At this time I've put most effort into the configuration and build side
> of things, solving the problems described above, and handling missing
> tools and packages gracefully. There are still issues to be ironed out
> in a) the kernel-doc script rst output and b) the xml template to rst
> conversion. These are somewhat orthogonal from each other and the build,
> and I expect some hand-editing will be required in the end.

Jon -

I've added a significant amount of polish. It works and it looks
pretty. The code is in the "sphinx-wip" branch of [1], gitweb at [2],
and Read the Docs built copy at [3].

There's roughly 30 commits there that I think are getting ready for
merging. The rest is scripted conversion of some DocBook templates for
demonstration purposes; I think the final conversion should be done by
the authors of the documents when they are ready to ditch the DocBook
templates in the same commit.

I also think I've now spearheaded this pretty close to a point where
more benefits can be gained by merging the work to docs-next, and
collaborating there.

Let me know what you think.


BR,
Jani.

PS. I never thought I'd do this much perl coding in my life. It didn't
kill me, I must be stronger now.


[1] git://people.freedesktop.org/~jani/drm
[2] https://cgit.freedesktop.org/~jani/drm/log/?h=sphinx-wip
[3] https://kernel.readthedocs.io/


--
Jani Nikula, Intel Open Source Technology Center