Publish marionette_driver API documentation to firefox-source-docs.m.o
Categories
(Remote Protocol :: Marionette, enhancement, P1)
Tracking
(firefox67 fixed)
| Tracking | Status | |
|---|---|---|
| firefox67 | --- | fixed |
People
(Reporter: ato, Assigned: ato)
References
Details
Attachments
(3 files)
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.
|
Assignee | |
Updated•6 years ago
|
|
|
Assignee | |
Comment 1•6 years ago
|
||
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.
|
|
Assignee | |
Comment 2•6 years ago
|
||
Depends on D18087
|
|
Assignee | |
Comment 3•6 years ago
|
||
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 5•6 years ago
|
||
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:
|
|
Assignee | |
Comment 6•6 years ago
|
||
(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:
I agree with you. Do you know what I have to do? I’ve never
interacted with readthedocs.io before…
|
|
||
Comment 7•6 years ago
|
||
(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: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•6 years ago
|
||
| bugherder | ||
https://hg.mozilla.org/mozilla-central/rev/1c41ce6588df
https://hg.mozilla.org/mozilla-central/rev/433d3e3125f3
https://hg.mozilla.org/mozilla-central/rev/cf4de37fb95d
|
||
Updated•2 years ago
|
Description
•