1091722 - Bring in-tree Sphinx docs into modernity

Status: RESOLVED FIXED

(Firefox Build System :: General, defect)

Description

[Gregory Szorc [:gps]]

There are things we can do to make the in-tree Sphinx docs more useful and available. Patches forthcoming.

Comment 1

[Gregory Szorc [:gps]]

Attachment: MozReview Request: bz://1091722/gps

Comment 2

[Gregory Szorc [:gps]]

/r/97 - Bug 1091722 - Remove requirements.txt
/r/99 - Bug 1091722 - Import Jenkins build script
/r/101 - Bug 1091722 - Move VM provisioning logic into Vagrantfile
/r/103 - Bug 1091722 - Remove some dead or legacy code from job script
/r/105 - Bug 1091722 - Use Ubuntu 14.04
/r/107 - Bug 1091722 - Discover Vagrant better
/r/109 - Bug 1091722 - Don't require configure before generating docs
/r/111 - Bug 1091722 - Update Jenkins configuration to not perform configure
/r/113 - Bug 1091722 - Use Read The Docs theme for Sphinx

Pull down these commits:

hg pull review -r 66172a04ea943a2a7b8961022c2cfc54643e77b3

Comment 3

[Gregory Szorc [:gps]]

https://reviewboard.mozilla.org/r/95/#review33

While the intent of this patch series was to enable docs generation on Read The Docs, I suspect more work is needed. I suspect we'll have to hack up conf.py to do all the magic currently performed in the mach command.

I like the patch series as-is: it brings us a few steps closer to docs publishing on Read The Docs. I'll likely follow up with another patch series to make Read The Docs work one this is landed.

Comment 4

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/97/#review35

Ship It!

Comment 5

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/109/#review37

Ship It!

Comment 6

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/113/#review39

::: tools/docs/conf.py
(Diff revision 1)
> -#html_theme_path = [mdn_theme.get_theme_dir()]
> +on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

get('READTHEDOCS')

Comment 7

[Mike Hommey [:glandium]]

https://reviewboard.mozilla.org/r/95/#review41

There are so many things to say about the jenkins.sh script at each level, yet they're irrelevant to the final file. Why bother importing the original script and modify it? Just import the patched file and /that/ will be reviewed.

Comment 8

[Gregory Szorc [:gps]]

/r/97 - Bug 1091722 - Remove requirements.txt; r=glandium
/r/113 - Bug 1091722 - Use Read The Docs theme for Sphinx; r=glandium
/r/109 - Bug 1091722 - Don't require configure before generating docs; r=glandium
/r/105 - Bug 1091722 - Use Ubuntu 14.04
/r/101 - Bug 1091722 - Add Jenkins build code

Pull down these commits:

hg pull review -r 991858342ed40e0569cc871e06856164c456dc1f

Comment 9

[Gregory Szorc [:gps]]

https://reviewboard.mozilla.org/r/95/#review45

I did some pretty heavy histedit work on this patch series. Dropped a few commits. Folded a few more. Moved the reviewed patches up in the series. And it looks like Review Board handled it quite nicely!

Comment 10

[Gregory Szorc [:gps]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/0ac9f9254f62
https://hg.mozilla.org/integration/mozilla-inbound/rev/07abf03ca145
https://hg.mozilla.org/integration/mozilla-inbound/rev/d87f06624e13

Comment 11

[Gregory Szorc [:gps]]

I pushed the Sphinx refactor. Will submit the Jenkins refactoring some other time: it isn't important.

Comment 12

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/0ac9f9254f62
https://hg.mozilla.org/mozilla-central/rev/07abf03ca145
https://hg.mozilla.org/mozilla-central/rev/d87f06624e13

Comment 14

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1091722 - Remove requirements.txt; r=glandium

Comment 15

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1091722 - Import Jenkins build script

Comment 16

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1091722 - Add Jenkins build code

Comment 17

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1091722 - Remove some dead or legacy code from job script

Comment 18

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1091722 - Use Ubuntu 14.04

Comment 19

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1091722 - Discover Vagrant better

Comment 20

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1091722 - Don't require configure before generating docs; r=glandium

Comment 21

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1091722 - Update Jenkins configuration to not perform configure

Comment 22

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1091722 - Use Read The Docs theme for Sphinx; r=glandium