On Sun, May 29, 2016 at 10:33 PM, Jani Nikula <jani.nikula@xxxxxxxxx> wrote: > 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. I've looked both through the patches in Jani's branch and the resulting docs. Spotted 2 nitpicks, which are already fixed, and it looks imo _really_ good. I think next steps is to get this merged into docs-next, with a stable tag, so that I can pull it into drm-misc. There's still piles of little polish to do to make it really pretty, but that's almost all in the kernel-doc comments or .rst files itself. I think for starting we could convert a few docs already, or just add the index.rst and leave conversions to maintainers. At least for gpu.tmpl I expect some need for cordination with ongoing work. -Daniel > > > 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 -- Daniel Vetter Software Engineer, Intel Corporation +41 (0) 79 365 57 48 - http://blog.ffwll.ch -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
