1523962 - Publish marionette_driver API documentation to firefox-source-docs.m.o

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, enhancement, P1)

Description

[Andreas Tolfsen ❲:ato❳]

https://marionette-client.readthedocs.io/en/master/ is out of date
and generates a lot of warnings. As we are intending to decommission
the public PyPI release of marionette_driver, it makes sense to
publish the API documentation to https://firefox-source-docs.mozilla.org/
instead.

Comment 1

[Andreas Tolfsen ❲:ato❳]

Attachment: bug 1523962: marionette: publish client and harness api docs to firefox-source-docs.m.o;

https://marionette-client.readthedocs.io/en/master/ is out of date
and generates a lot of warnings. As we are intending to decommission
the public PyPI release of marionette_driver, it makes sense to
publish the API documentation to https://firefox-source-docs.mozilla.org/
instead.

Comment 2

[Andreas Tolfsen ❲:ato❳]

Attachment: bug 1523962: marionette: correct link to client docs;

Depends on D18087

Comment 3

[Andreas Tolfsen ❲:ato❳]

Attachment: bug 1523962: marionette, geckodriver: fix published docs location;

Sphinx creates an additional directory level unless the entry starts
with "/". By using the aboslute path we can define where we want
the documentation to end up.

This causes the geckodriver and Marionette documentation to move from:

/testing/marionette/marionette
/testing/geckodriver/geckodriver

to:

/testing/marionette
/testing/geckodriver

Depends on D18088

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1c41ce6588df
marionette: publish client and harness api docs to firefox-source-docs.m.o; r=ahal
https://hg.mozilla.org/integration/autoland/rev/433d3e3125f3
marionette: correct link to client docs; r=ahal
https://hg.mozilla.org/integration/autoland/rev/cf4de37fb95d
marionette, geckodriver: fix published docs location; r=ahal

Comment 5

[William Lachance (:wlach)]

Thank you! Assuming this sticks, I would suggest deleting the old documentation, so people don't get confused? If you'd prefer to redirect, you could use the mozbase approach, but tbh I'm not sure if it's worthwhile:

https://github.com/mozilla/mozbase-deprecated/

Comment 6

[Andreas Tolfsen ❲:ato❳]

(In reply to William Lachance (:wlach) (use needinfo!) from comment #5)

Thank you! Assuming this sticks, I would suggest deleting the old
documentation, so people don't get confused? If you'd prefer to
redirect, you could use the mozbase approach, but tbh I'm not sure
if it's worthwhile:

https://github.com/mozilla/mozbase-deprecated/

I agree with you. Do you know what I have to do? I’ve never
interacted with readthedocs.io before…

Comment 7

[William Lachance (:wlach)]

(In reply to Andreas Tolfsen ⦗:ato⦘ from comment #6)

(In reply to William Lachance (:wlach) (use needinfo!) from comment #5)

Thank you! Assuming this sticks, I would suggest deleting the old
documentation, so people don't get confused? If you'd prefer to
redirect, you could use the mozbase approach, but tbh I'm not sure
if it's worthwhile:

https://github.com/mozilla/mozbase-deprecated/

I agree with you. Do you know what I have to do? I’ve never
interacted with readthedocs.io before…

IIRC there's a "delete site" button somewhere. I can press it for you if you like. :)

Comment 8

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/1c41ce6588df
https://hg.mozilla.org/mozilla-central/rev/433d3e3125f3
https://hg.mozilla.org/mozilla-central/rev/cf4de37fb95d