https://bugzilla.wikimedia.org/show_bug.cgi?id=64846
Bug ID: 64846 Summary: Provide sensible documentation platform Product: Pywikibot Version: core (2.0) Hardware: All OS: All Status: NEW Severity: normal Priority: Unprioritized Component: General Assignee: Pywikipedia-bugs@lists.wikimedia.org Reporter: valhallasw@arctus.nl CC: info@gno.de, maarten@mdammers.nl Blocks: 64840 Web browser: --- Mobile Platform: ---
The typical documentation platform for Python projects is Sphinx (combined with readthedocs, typically). However, we have Mediawiki.org, which has the advantage of having translated pages.
It would be nice to have the English docs in the git repository, as that would make keeping them up-to-date *much* easier. In addition, that would make it much easier to auto-generate parts of the documentation (e.g. script parameters and API docs).
It would be nice if we could find a way to have the best of both worlds, e.g. by having something that parses docs to Translate-enabled wikitext.