KBach added subscribers: komla, TBurmeister, apaskulin, srishakatux, Xqt. KBach added a comment.
I have spent some time looking into these improvements and put together a proposal for a few changes to https://doc.wikimedia.org/pywikibot/master/: 1. Replace the current theme with Furo (https://pradyunsg.me/furo/) for a more modern look and feel and some additional functionality. 2. Modify content structure to make navigation a bit easier. As a result, the documentation could look like in the screenshots below: F35730464: example_1.png <https://phabricator.wikimedia.org/F35730464> F35730469: example_2.png <https://phabricator.wikimedia.org/F35730469> F35730492: example_2_dark.png <https://phabricator.wikimedia.org/F35730492> F35730497: example_3.png <https://phabricator.wikimedia.org/F35730497> While change 2 does not explicitly rely on change 1, the separation of local (on the right) and global (on the left) navigation in Furo looks really impactful. We could replicate a part of that functionality (global navigation on the left) in the current theme, but local navigation on the right would take too much work to be achievable with the current theme at the moment. I will be preparing a pull request with these changes shortly, but wanted to first reach out and gather preliminary feedback. I'm also happy to discuss this on IRC or during a live session with anyone interested. Note that this is a very early draft that I hope we'll be able to improve together. The complete list of proposed changes: - Change theme to Furo. - Add the sphinx-opengraph extension. - In Furo, customize edit links to allow readers to access source RST files in the repo easily. - Allow users to navigate between pages using arrow keys (left for previous, right for next). - Change pygments styles for light and dark modes. - Add `make mini` to Makefile as a way to quickly rebuild docs after minor changes. - Remove redundant content in the navigation structure. - Introduce documentation sections "User guide", "Bot developer guide", "Pywikibot contributor guide", and "Other" - replacing existing "For bot users", "For bot developers", "For framework developers". - Introduce new sections on multiple pages to ease on-page navigation using the right-side menu - Introduce minor style changes. FYI @Xqt @komla @srishakatux @TBurmeister @apaskulin TASK DETAIL https://phabricator.wikimedia.org/T322212 EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/ To: KBach Cc: Xqt, srishakatux, apaskulin, TBurmeister, komla, binbot, Aklapper, pywikibot-bugs-list, whym, KBach, Maberdour, PotsdamLamb, Jyoo1011, JohnsonLee01, SHEKH, Dijkstra, Khutuck, Zkhalido, Demian, Pavithraes, Urstrulykkr, Viztor, Wenyi, Jayprakash12345, Tbscho, MayS, Mdupont, JJMC89, Dvorapa, Altostratus, Avicennasis, mys_721tx, Gryllida, jayvdb, Masti, Alchimista, Rfarrand, bd808, jeremyb
_______________________________________________ pywikibot-bugs mailing list -- [email protected] To unsubscribe send an email to [email protected]
