1115278 - Make Sphinx docs work with Read The Docs

Status: RESOLVED FIXED

(Firefox Build System :: General, defect)

Description

[Gregory Szorc [:gps]]

Read The Docs is amazing. It would be even more amazing if we could host Firefox' Sphinx docs on it.

Comment 1

[Mike Hommey [:glandium]]

I'm not really thrilled to have yet another place to look at for Mozilla docs. It's already confusing enough.

Comment 2

[Gregory Szorc [:gps]]

My goal is to make RTD the canonical home and to kill the Jenkins CI (unless of course we want to keep it running so we get alerts when it fails).

Comment 3

[Mike Hommey [:glandium]]

I'd rather have some automation put things on mdn or wiki.m.o than having yet another documentation url. That actually applies to what's currently on ci.mozilla.org. But I'll leave the final word to Sheppy. I'm merely mentioning my developer POV.

Comment 4

[Gregory Szorc [:gps]]

Bug 920314 is on file to host the docs on MDN. Last update, they are unable to "import" Sphinx docs directly into MDN. Instead, they install URL proxies to expose docs from RTD on MDN. So getting the docs published on RTD is a prerequisite to getting them on MDN.

Comment 5

[Gregory Szorc [:gps]]

Attachment: MozReview Request: bz://1115278/gps

Comment 6

[Gregory Szorc [:gps]]

/r/1727 - Bug 1115278 - Move Sphinx build scanning into moztreedocs
/r/1729 - Bug 1115278 - Store docs directory in a variable
/r/1731 - Bug 1115278 - Move Sphinx documentation staging into Sphinx extension
/r/1733 - Bug 1115278 - Add virtualenv to Sphinx environment
/r/1735 - Bug 1115278 - Fix mach documentation issues

Pull down these commits:

hg pull review -r e550299f0d19db8739bbbd3979c68fdee1b2be1e

Comment 7

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/1727/#review1127

Ship It!

Comment 8

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/1729/#review1129

Ship It!

Comment 9

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/1731/#review1131

Ship It!

Comment 10

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/1733/#review1133

::: python/mozbuild/mozbuild/sphinx.py
(Diff revision 1)
> -    app.srcdir = manager._docs_dir
> +    app.srcdir = os.path.join(app.outdir, '_staging')

why change this?

Comment 11

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/1735/#review1135

Ship It!

Comment 12

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/1725/#review1137

Ship It!

Comment 13

[Gregory Szorc [:gps]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/8656f5cdba46
https://hg.mozilla.org/integration/mozilla-inbound/rev/01ece2e26ef9
https://hg.mozilla.org/integration/mozilla-inbound/rev/6e708bf5daab
https://hg.mozilla.org/integration/mozilla-inbound/rev/245bebb9e0d2
https://hg.mozilla.org/integration/mozilla-inbound/rev/9acf0e1ecae6

Comment 14

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/8656f5cdba46
https://hg.mozilla.org/mozilla-central/rev/01ece2e26ef9
https://hg.mozilla.org/mozilla-central/rev/6e708bf5daab
https://hg.mozilla.org/mozilla-central/rev/245bebb9e0d2
https://hg.mozilla.org/mozilla-central/rev/9acf0e1ecae6

Comment 16

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1115278 - Move Sphinx build scanning into moztreedocs

Comment 17

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1115278 - Store docs directory in a variable

Comment 18

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1115278 - Move Sphinx documentation staging into Sphinx extension

Comment 19

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1115278 - Add virtualenv to Sphinx environment

Comment 20

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1115278 - Fix mach documentation issues