search

4teamwork / ftw.testbrowser

A testing browser for Plone.
http://ftwtestbrowser.readthedocs.io/
5 stars 1 forks source link

API docs are broken #61

Closed lukasgraf closed 7 years ago

lukasgraf commented 7 years ago

The API docs currently seem to be broken: http://ftwtestbrowser.readthedocs.io/en/stable/api_browser.html

Probably an issue with the Sphinx autodocs extension.

ftw_testbrowser_apidocs

jone commented 7 years ago

I could fix the build for the new version 1.24.3 and stable. Older versions are still broken. The problem was that read the docs installed all requirements in setup.py, but didn't have our version pinnings.

It is important that all dependencies are installed in order to include the source documentation, since Sphinx needs to import the python modules without ImportErrors.

I've now added a rtd-requirements.txt, which can be automatically generated with the rtd-update-requirements.py script (on a local developer notebook after running buildout sucessfully). It contains all important dependencies with their versions. The requirements file does not include the packages which rtd installs with a specific version, such as sphinx itself.