1468261 - Building marionette-client documentation fails

Status: RESOLVED INVALID

(Remote Protocol :: Marionette, enhancement, P2)

Description

[Henrik Skupin [:whimboo][⌚️UTC+1]]

The marionette-client documentation is not uptodate on readthedocs.io. As a check has shown it fails to build for more than 6 months now!

I cleaned-up all workspaces on readthedocs and triggered a build for the master branch. Maybe this helps already.

Comment 1

[Henrik Skupin [:whimboo][⌚️UTC+1]]

So the build of the documentation still fails:

https://readthedocs.org/api/v2/build/7329014.txt

> [rtd-command-info] start-time: 2018-06-11T22:57:06.100037, end-time: 2018-06-11T22:57:06.132455, duration: 0, exit-code: 0
> git remote set-url origin https://github.com/mozilla/gecko-dev.git
> 
> 
> [rtd-command-info] start-time: 2018-06-11T22:57:06.248818, end-time: 2018-06-11T22:57:43.457739, duration: 37, exit-code: 128
> git fetch --tags --prune
> fatal: pack has 176 unresolved deltas
> fatal: index-pack failed

So something does not actually work with cloning the git mirror.

Maybe it would be a good idea to not further investigate that but just let it generate docs for firefox-source-docs (see bug 1453099), and publish it under:

> https://firefox-source-docs.mozilla.org/testing/marionette/client

I think that should be faster, and necessary anyway. Andreas, any thoughts?

Comment 2

[Andreas Tolfsen ❲:ato❳]

So I don’t know why the documentation currently fails to build, but
I think fixing it is indeed a distraction.  Time would be better
spent integrating it with "./mach doc" and firefox-source-docs.m.o.

One point to note is that we will have to redirect
http://marionette-client.readthedocs.io/en/master/.

Comment 3

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Ok, so lets get bug 1453099 done, and then do the redirect via this bug.

Comment 4

[Henrik Skupin [:whimboo][⌚️UTC+1]]

(In reply to Andrew Halberstadt [:ahal] from bug 1453099 comment #1)
> Pasting my newsgroup comment for whoever ends up tackling this:
> 
> When moving the mozbase docs to firefox-source-docs.mozilla.org, I was able
> to set up a root level redirect like this:
> https://github.com/mozilla/mozbase-deprecated/commit/
> c6331176a3606cae7d99846dab9ad677667e932d
> 
> You'll need to create a dummy github repo and change the old doc location to
> build off of it. You can also set up page level redirects in the readthedocs
> settings. I had to enter each page manually, but it wasn't too bad.

Comment 5

[Andreas Tolfsen ❲:ato❳]

It appears building the documentation now works. Since this bug was filed we have moved the documentation to https://firefox-source-docs.mozilla.org/python/marionette_driver.html in light of https://lists.mozilla.org/pipermail/tools-marionette/2019-January/000068.html. That renders this bug invalid.