In https://phabricator.wikimedia.org/T66846 John made documentation using Sphinx. A preview of this is available at http://pywikibot.readthedocs.org/en/latest/pywikibot . This documentation should be published on doc.wikimedia.org and regularly updated.
Antoine, can you help with this?
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | valhallasw | T89590 Publish Pywikibot documentation on doc.wikimedia.org | |||
| Resolved | jayvdb | T66846 Provide sensible documentation platform for Pywikibot |
@Multichill , should this task be blocked by T66846 , or the other way around?
See also T88999 .
Imho you should get the code to generate the documentation first (T66846) then it is in theory trivial to publish it to doc.wikimedia.org :)
We can already generate the documentation, however it isnt merged as more work is needed to generate it for readthedocs (which is py3.4, without optimise flag).
If doc.wikimedia.org can use (e.g. via Makefile) python (py27, py33 or py34) _with_ optimise flag enabled (python -O), then the sphinx bit can be reviewed&merged with that as the target.
We can have a jenkins job for either python 2.7 or 3.4 up to you guys. There is a nose34 tox env that uses python3.4 and the related job is tied to Trusty instances which have it :)
scratch that; it needs to be py27. py3 introduces namespace(and therefore packaging) problems.