Closed Bug 1260656 Opened 4 years ago Closed 4 years ago

Fix firefox-puppeteer documentation generation on Readthedocs

Categories

(Testing :: Firefox UI Tests, defect)

defect
Not set

Tracking

(firefox48 fixed)

RESOLVED FIXED
mozilla48
Tracking Status
firefox48 --- fixed

People

(Reporter: whimboo, Assigned: sydpolk)

References

Details

Attachments

(2 files)

The generation of our documentation on readthedocs is currently busted, even with the webhook re-enabled. The problem is that the firefox-puppeteer package is not getting installed via "python setup.py install". That is the reason because setup.py is not found because no path can be specified to it. That's why they only look at the root folder and fail.

I will have to play around a bit today and figure out what's possible to get this fixed. If there is no way we may have to make our docs part of in-tree sphinx docs: https://gecko.readthedocs.org/
The reason why the documentation for external media tests was working about a week ago but fails now is the removal of the following line in the requirements.txt file:

https://hg.mozilla.org/mozilla-central/rev/cc0e742eafa5#l1.16

So I'm currently trying a build on readthedocs for my gecko-dev fork with a new requirements.txt file included inside the docs sub folder. It only contains a line with "..", which will install the puppeteer package and all of its dependencies.
So there is no way to instruct readthedocs to run a specific setup.py. That's why we should create a new requirements file only for the doc generation. We can specify that one perfectly, so docs will be generated. Patch is coming up.
Assignee: nobody → hskupin
Status: NEW → ASSIGNED
https://reviewboard.mozilla.org/r/43201/#review39759

::: testing/puppeteer/firefox/firefox_puppeteer/ui/menu.py
(Diff revision 1)
>      def get_menu_by_id(self, menu_id):
>          """Get a :class:`MenuElement` instance corresponding to the specified
>          ID.
>  
> -        :param menu_id: The ID of the menu, e.g., **file-menu** or
> +        :param menu_id: The ID of the menu, e.g., **file-menu** or **view-menu**.
> -        **view-menu**.

This fixes warnings for the doc generation.
Comment on attachment 8736295 [details]
MozReview Request: Bug 1260656 - Fix firefox-puppeteer documentation generation for Readthedocs. r?maja_zf

https://reviewboard.mozilla.org/r/43201/#review39789
Attachment #8736295 - Flags: review?(mjzffr) → review+
Syd, may you be able to come up with a follow-up fix similar to the external media tests? I won't be able to do it anymore now. Thanks.
Flags: needinfo?(spolk)
Assignee: hskupin → spolk
Flags: needinfo?(spolk)
Should be straightforward.
https://hg.mozilla.org/mozilla-central/rev/57a583c7c310
Status: ASSIGNED → RESOLVED
Closed: 4 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla48
One last fix will need to be made:


python -mvirtualenv --no-site-packages /home/docs/checkouts/readthedocs.org/user_builds/firefox-puppeteer/envs/latest
python /home/docs/checkouts/readthedocs.org/user_builds/firefox-puppeteer/envs/latest/bin/pip install --use-wheel -U --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/firefox-puppeteer/.cache/pip sphinx==1.3.5 Pygments==2.1.3 setuptools==20.1.1 docutils==0.12 mkdocs==0.15.0 mock==1.0.1 pillow==2.6.1 git+https://github.com/rtfd/readthedocs-sphinx-ext.git@0.6-alpha#egg=readthedocs-sphinx-ext sphinx-rtd-theme==0.1.9 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.5.4 recommonmark==0.1.1
python /home/docs/checkouts/readthedocs.org/user_builds/firefox-puppeteer/envs/latest/bin/pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/firefox-puppeteer/.cache/pip -rtesting/puppeteer/firefox/requirements-docs.txt
Directory '.' is not installable. File 'setup.py' not found.
You are using pip version 7.1.2, however version 8.1.1 is available.
You should consider upgrading via the 'pip install --upgrade pip' command.
Status: RESOLVED → REOPENED
Resolution: FIXED → ---
Comment on attachment 8738273 [details]
MozReview Request: Bug 1260656 - Fix firefox-puppeteer documentation generation for Readthedocs. r?maja_zf

https://reviewboard.mozilla.org/r/44411/#review41135
Attachment #8738273 - Flags: review?(mjzffr) → review+
https://hg.mozilla.org/mozilla-central/rev/762792f533a2
Status: REOPENED → RESOLVED
Closed: 4 years ago4 years ago
Resolution: --- → FIXED
Thanks Syd for finishing this up.
You are welcome.
You need to log in before you can comment on or make changes to this bug.