Messages in this thread | | | From | Jani Nikula <> | Subject | Re: Kernel docs: muddying the waters a bit | Date | Fri, 06 May 2016 18:52:08 +0300 |
| |
On Fri, 06 May 2016, Markus Heiser <markus.heiser@darmarit.de> wrote: > Am 06.05.2016 um 17:06 schrieb Jani Nikula <jani.nikula@intel.com>: > >> On Fri, 06 May 2016, Markus Heiser <markus.heiser@darmarit.de> wrote: >>> @Jonathan: what do you think? Should I prepare a patch >>> with a basic reST (sphinx) build infrastructure, including >>> >>> * a folder for sphinx docs: >>> >>> ./Documentation/sphinx/ >> >> I'm already working on a patch series taking a different approach. I >> don't think we should hide the documentation under an extra folder named >> after a tool. Actually, I'm strongly opposed to that. > > Could you post a link to a repo? / thanks
Very much a work-in-progress https://cgit.freedesktop.org/~jani/drm/log/?h=sphinx
I was hoping to polish it a bit more before showing it to the world.
> There is no need for concurrency, let's work together on your repo. > Within my POC I realized similar building processes we will need in the > kernel sources ... where you have cascading configuration. A base > configuration which fits for all common cases and (if needed) a > *per-book* configuration. > > At the end, when it comes to generate pdf books/articles, man pages > and e.g. texinfo files out of a sphinx-project you will need a build > infrastructure like this.
...
> You will need on sphinx-project for each DocBook and one single > sphinx-project where you collect the .txt to .rst migrated files.
Surely you know more about Sphinx than I do, but I specifically would like to include e.g. gpu documentation in the main build. I'm really hoping we can have *additional* configuration files for special cases (only) as needed.
BR, Jani.
-- Jani Nikula, Intel Open Source Technology Center
| |