Closed Bug 1260872 Opened 8 years ago Closed 8 years ago

The docs are not being generated correctly on readthedocs.

Categories

(Testing Graveyard :: external-media-tests, defect)

defect
Not set
normal

Tracking

(firefox48 fixed)

RESOLVED FIXED
mozilla48
Tracking Status
firefox48 --- fixed

People

(Reporter: sydpolk, Assigned: sydpolk)

Details

Attachments

(2 files)

http://external-media-tests.readthedocs.org/en/latest/external_media_tests.media_tests.video_puppeteer.html is blank.

This is because there is no way to specify the setup.py to run to setup the virtualenv (https://github.com/rtfd/readthedocs.org/issues/2097). Firefox UI Tests have the same problem, and that is tracked in bug 1260656
I am trying to workaround in bug 1260656.
Assignee: nobody → spolk
With this change pushed to https://github.com/sydvicious/gecko-dev.git, readthedocs generates this for the previously bad page.

http://external-media-tests.readthedocs.org/en/latest/external_media_tests.media_tests.video_puppeteer.html

I will post a screenshot as well.
Comment on attachment 8736504 [details]
MozReview Request: Bug 1260872 - The docs are not being generated correctly on readthedocs - r?whimboo

https://reviewboard.mozilla.org/r/43325/#review40009

I would propose we wait until we know that my patch fixes it correctly and readthedocs content has been updated. Beside that see also my inline question.

::: dom/media/test/external/requirements-docs.txt:4
(Diff revision 1)
> +sphinx
> +sphinx-rtd-theme
> +
> +-e dom/media/test/external

I don't see how this would work. You are already in that path. Specifying the full path again would mean that it tries to install the package from `dom/media/test/external/dom/media/test/external` or not?
Attachment #8736504 - Flags: review?(hskupin)
With "-e .", readthedocs build does this:


python /home/docs/checkouts/readthedocs.org/user_builds/external-media-tests/envs/latest/bin/pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/external-media-tests/.cache/pip -rdom/media/test/external/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.

It certainly seems to me that the current directory is the top-level. With the version I submitted, it works perfectly.
Comment on attachment 8736504 [details]
MozReview Request: Bug 1260872 - The docs are not being generated correctly on readthedocs - r?whimboo

https://reviewboard.mozilla.org/r/43325/#review40081

::: dom/media/test/external/requirements-docs.txt:4
(Diff revision 1)
> +sphinx
> +sphinx-rtd-theme
> +
> +-e dom/media/test/external

Interesting. So that would mean my patch for puppeteer is wrong and also needs the full path down to the package dir.
Attachment #8736504 - Flags: review+
Comment on attachment 8736504 [details]
MozReview Request: Bug 1260872 - The docs are not being generated correctly on readthedocs - r?whimboo

https://reviewboard.mozilla.org/r/43325/#review40069

::: dom/media/test/external/requirements-docs.txt:4
(Diff revision 1)
> +sphinx
> +sphinx-rtd-theme
> +
> +-e dom/media/test/external

With "-e .", readthedocs build does this:


<code>
python /home/docs/checkouts/readthedocs.org/user_builds/external-media-tests/envs/latest/bin/pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/external-media-tests/.cache/pip -rdom/media/test/external/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.
</code>

It certainly seems to me that the current directory is the top-level. With the version I submitted, it works perfectly.
Attachment #8736504 - Flags: review+
https://hg.mozilla.org/mozilla-central/rev/2528365bac07
Status: NEW → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla48
The docs fail to generate with the requirements given:


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.

I ran into similar issues with external media tests.
Status: RESOLVED → REOPENED
Resolution: FIXED → ---
Oops. Reopened wrong bug.
Status: REOPENED → RESOLVED
Closed: 8 years ago8 years ago
Resolution: --- → FIXED
Product: Testing → Testing Graveyard
You need to log in before you can comment on or make changes to this bug.