[Pywikibot-commits] [Gerrit] docs: only apply magic to scripts - change (pywikibot/core)

[jenkins-bot (Code Review)]

jenkins-bot has submitted this change and it was merged.

Change subject: docs: only apply magic to scripts
......................................................................


docs: only apply magic to scripts

Change-Id: I651ccd9a621b59280923ab6c7f2fda4bd06708d7
---
M docs/conf.py
1 file changed, 5 insertions(+), 0 deletions(-)

Approvals:
  XZise: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/docs/conf.py b/docs/conf.py
index 7d24345..917ff79 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -248,6 +248,11 @@
 def pywikibot_script_docstring_fixups(
         app, what, name, obj, options, lines):
     """Pywikibot specific conversions."""
+    if what != "module":
+        return
+
+    if os.path.sep + "scripts" + os.path.sep not in obj.__file__:
+        return
     for index, line in enumerate(lines):
         if line in ('&params;', '&pagegenerators_help;'):
             lines[index] = ('This script supports use of '

-- 
To view, visit https://gerrit.wikimedia.org/r/238011
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I651ccd9a621b59280923ab6c7f2fda4bd06708d7
Gerrit-PatchSet: 1
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: Merlijn van Deen <valhall...@arctus.nl>
Gerrit-Reviewer: John Vandenberg <jay...@gmail.com>
Gerrit-Reviewer: Ladsgroup <ladsgr...@gmail.com>
Gerrit-Reviewer: XZise <commodorefabia...@gmx.de>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
Pywikibot-commits mailing list
Pywikibot-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/pywikibot-commits