yes, the documentation at dwo is 99% from docstrings and readme and other information files. The underlying markup is restructuredtext but sphinx is used to create the final documentation files; it comes with additional roles and elements for reference links, creates table of contents, module index, element index etc. The sphinx documentation can be found at https://www.sphinx-doc.org/en/master/

Best

xqt



Thank you, I could not follow the details, but anyway, that was a great work.

Please help me understand the infrastructure.

We have Manual:Pywikibot on mediawiki.org, which is a completely manual work.

Quite independently, we have https://doc.wikimedia.org/pywikibot/, which should be partially? completely? automatic. It comes from docstrings of scripts and methods.

Is that correct?

The syntax in docstrings is strange for me. Where is it described?

<info@gno.de> ezt írta (időpont: 2022. dec. 15., Cs, 18:21):

Hi all,

our Pywikibot documentation has been revised (thank you KBach).

Please visit the new documentation style. Comments are very welcome at https://phabricator.wikimedia.org/T322212 or by replying this mail.

- https://doc.wikimedia.org/pywikibot/tests/ the new furo theme with Sphinx 5.3
- https://doc.wikimedia.org/pywikibot/master/ the old nature theme with Sphinx 5.3
- https://doc.wikimedia.org/pywikibot/stable/ the old nature theme with Sphinx 5.1.1

Best
xqt
 

_______________________________________________
pywikibot mailing list -- pywikibot@lists.wikimedia.org
To unsubscribe send an email to pywikibot-leave@lists.wikimedia.org

--

Bináris

_______________________________________________
pywikibot mailing list -- pywikibot@lists.wikimedia.org
To unsubscribe send an email to pywikibot-leave@lists.wikimedia.org