641672 - cfx docs fails to generate many pages

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect)

Description

[Alexandre Poirot [:ochameau]]

Simply running cfx docs on current master fails on many pages on Win7, Firefox 4RC1.
The first index page works perfectly.
Then the following page is working but without CSS:
http://localhost:8888/
http://localhost:8888/dev-guide/addon-development/about.html
Finally if I try to load any module page, it totally fail with unable to connect error or 404 error:
http://localhost:8888/dev-guide/addon-development/packages/addon-kit/docs/clipboard.html

Comment 1

[Alexandre Poirot [:ochameau]]

I do not understand why it is failing only for me but it seems to be an error with <base> tag.
If I use base URL: <base href="http://localhost:8888/"> everything comes back to normal.

See static-files/base.html:5 and python-lib/cuddlefish/webdocs.py:126

Comment 2

[Will Bamberg [:wbamberg]]

This: https://github.com/mozilla/addon-sdk/pull/123 looks like an important fix that could resolve this problem. I'd like to pull this fix into 1.0b4 anyway.

Comment 3

[Myk Melez [:myk] [@mykmelez]]

Hmm, I haven't been able to reproduce on my Windows 7 VM.  The home page <http://127.0.0.1:8888/>, Developer Guide page <http://127.0.0.1:8888/dev-guide/addon-development/about.html>, and clipboard page <http://127.0.0.1:8888/packages/addon-kit/docs/clipboard.html> all work fine for me.

However, my clipboard page URL is different from the one Alex posted:

Alex: http://localhost:8888/dev-guide/addon-development/packages/addon-kit/docs/clipboard.html
Myk: http://127.0.0.1:8888/packages/addon-kit/docs/clipboard.html

It looks like Alex's URL is relative to the path of the Developer Guide page, which he was on when he tried to load the clipboard page.  That suggests a base URL problem that pull request 123 might solve, although it's hard to say for sure without a machine on which I can reproduce the problem.

Comment 4

[Alexandre Poirot [:ochameau]]

Attachment: Pull request 123

I confirmed that this pull request fix this problem.
We should really land this before releasing first 1.0b4 version.

Comment 5

[Alexandre Poirot [:ochameau]]

Ok so this <base> bug doesn't concern Firefox 4, nor chrome.
You will face error decribed in comment 3 when you open docs in Firefox 3.6!

Comment 6

[Will Bamberg [:wbamberg]]

(In reply to comment #4)
> Created attachment 519632 [details]
> Pull request 123
> 
> I confirmed that this pull request fix this problem.
> We should really land this before releasing first 1.0b4 version.

Thanks Alex! Yes, I'll get that pull request into 1.0b4.

Comment 7

[Will Bamberg [:wbamberg]]

Comment on attachment 519632 [details]
Pull request 123

This looks good to me. If you could pull this I'll update the credits page.

Comment 8

[Alexandre Poirot [:ochameau]]

landed:
https://github.com/mozilla/addon-sdk/commit/a31788e521861357fd9f37ffccbfdd8893e65b61