Re: Building directly with sphinx

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

 



On Thu, May 21, 2020 at 10:35:51AM +0200, Markus Heiser wrote:
> > 
> > I was playing around with readthedocs.org recently and wanted to see if
> > I could build kernel docs there. I cannot directly run "make htmldocs"
> > there, and it proved to be quite tricky to make sphinx do the right
> > thing without all the things that are being defined in the Makefile.
> > 
> > Is it possible at all, or am I wasting my time?
> 
> It is wasting time ;) .. The Makefile targets do build intermedaiate
> files using perl and other scripts, this will never work on RTD.

Okay, I'd suspected as much after poking around things a bit. Another 
possibility would be to have a separate repository where we commit the 
doc tree (after it's massaged into the "ready to be built with sphinx" 
condition). We could run this automatically on our end on each mainline 
release, but it's certainly not a necessity.

> FWIW: in other projects I worked some time with RTD but at the end
> I gave up: If you have e.g. auto generated content in your build
> process which is not generated by the python developer-mainstream
> tools, RTD gives you too little freedom to implement your more
> or less complex build procedures.  And .. often I get the RTD-Oops
> links from search engines ..  RTD is (my experience is a  while
> ago; "was") not very comfortable to to rebind obsolete URLs to
> new content.
> 
> Overall I think kernel.org does a good job .. since years, no need
> for additional RTD confusions;
> 
>    https://www.kernel.org/doc/html/latest/

Glad to hear it. My primary interest in getting it hooked up with RTD 
was just from the perspective of creating an external mirror for folks 
who are already using RTD. For now, I'm going to shelve this effort and 
just continue building docs straight from the tree on our end.

Thanks for your help!

-K



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux