Page MenuHomePhabricator

Add documentation for scripts
Closed, ResolvedPublic

Description

The Pywikibot documentation https://doc.wikimedia.org/pywikibot/index.html is for the library only. Need to add scripts.

This was dropped from the documentation changeset due to

  • extra dependencies not yet installed on the CI server
  • scripts importing from other scripts using non-PY3 compatible syntax.

Event Timeline

jayvdb raised the priority of this task from to Medium.
jayvdb updated the task description. (Show Details)
jayvdb subscribed.
Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald Transcript

Couldn't we partly exclude some scripts which have these dependencies not solved yet?

Change 365204 had a related patch set uploaded (by Xqt; owner: Xqt):
[pywikibot/core@master] [DOC] Add scripts file to docs

https://gerrit.wikimedia.org/r/365204

Change 365204 merged by jenkins-bot:
[pywikibot/core@master] [DOC] Add scripts file to docs

https://gerrit.wikimedia.org/r/365204

Change 370161 had a related patch set uploaded (by Xqt; owner: Xqt):
[pywikibot/core@master] [bugfix] Fix scripts path in metafile

https://gerrit.wikimedia.org/r/370161

Change 370161 merged by jenkins-bot:
[pywikibot/core@master] [bugfix] Fix scripts path in metafile

https://gerrit.wikimedia.org/r/370161

@Xqt What is the state of this task?

As I see it, docs for scripts are mostly ok. There are some scripts missing (e.g. harvest_template.py but it shoudl be easily detected from console warnings). Therefore this task seems to me as solved for majority of scripts and could be either closed or left as a tracking task for those remaining to be fixed.

Xqt claimed this task.