Bug 14612

Summary:	offline/local installation of documentation
Product:	[Documentation] Mega Manual	Reporter:	Robert Berger <pokylinux>
Component:	mega-manual	Assignee:	Robert Berger <pokylinux>
Status:	RESOLVED NOTABUG	QA Contact:
Severity:	normal
Priority:	Medium	CC:	michael.opdenacker, randy.macleod, sjolley.yp.pm
Version:	unspecified
Target Milestone:	4.0
Hardware:	x86
OS:	Multiple
Whiteboard:
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	Don't know

Description Robert Berger 2021-10-23 08:31:56 UTC

1) Host your own local version of e.g. the mega manual with a web server

All the links e.g. BB_SERVER_TIMEOUT seem to go outside http://docs.yoctoproject.org/singleindex.html#term-BB_SERVER_TIMEOUT go outside to the 

2) same but without a web server - just opening the .html with a browser.

Maybe I need to rebuild the doc and change some variables?

Comment 1 Michael Opdenacker 2021-10-29 15:08:44 UTC

Hi Robert

Thanks for the bug report.

I looked at the output from "make singlehtml", and everything looks good to me as far as I checked. The internal links in the megamanual seem to work fine.

Are you sure your URLs are correct?
On my side, I had to use singlehtml/index.html#term-BB_SERVER_TIMEOUT
instead of what you mentioned.

Marking the bug as NEEDINFO as I cannot reproduce it at this stage.
Don't hesitate to set it back to NEW after adding details.

Thanks
Michael.

Comment 2 Robert Berger 2021-12-01 12:04:35 UTC

I built the doc (make publish) and got something working.

Up to now I just downloaded the html doc ;)

Now with "singlehtml" things seems to work (not going outsite to docs.yoctoproject.org) except for the other problem with not unique links.

We have the same link (I guess auto generated) multiple times in the html, which I need to patch in order to link from my pdf files to the right one.

Something like that:

Index: final-yocto/singleindex.html
===================================================================
--- final-yocto.orig/singleindex.html
+++ final-yocto/singleindex.html
@@ -32337,7 +32337,7 @@ log into the <a class="reference externa
 <div class="line"><br /></div>
 </div>
 <div class="toctree-wrapper compound">
-<span id="document-kernel-dev/intro"></span><section id="introduction">
+<span id="document-kernel-dev/intro"></span><section id="kernel-dev-introduction">
 <h3><span class="section-number">1 </span>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h3>
 <section id="overview">
 <h4><span class="section-number">1.1 </span>Overview<a class="headerlink" href="#overview" title="Permalink to this headline"></a></h4>

Comment 3 Michael Opdenacker 2021-12-01 15:26:35 UTC

Thanks for your comment. You're referring to the remaining bug on https://bugzilla.yoctoproject.org/show_bug.cgi?id=14436

Closing this one, and keeping the other one.
Thanks!