#6721 (Improve docs about plugin settings)
by Luc Saffre · in Developers · assigned to Luc Saffre
Summary
Settings should be documented in the hosting guide. Until now they aren't because the hg has no doctests, because doctests require the demo projects. So a next step for this would be to split the book into to repositories: dg (for developer guide) and lino_demos. To be more stepwise, we can move only one of these two halves into a new repo and keep the other unchanged: move the docs into a new repo "dg" and let lino_book continue to live with its historical name.
Children
Comments
- 6 months, 2 weeks ago by Luc Saffre about #6721 (Improve docs about plugin settings) : I now optimized the help text extraction: it no longer stores descriptions of Plugin classes in the help_texts.py files (anyway these texts were not used).
- 6 months, 2 weeks ago by Luc Saffre about #6721 (Improve docs about plugin settings) : The
lino.modlib.help.utils.HelpTextLoadernow also loads help texts for plugin settings, and the new functionlino.api.doctest.show_plugin_settings()shows them (as demonstrated in cosi1 : A Lino Così for Belgium (DE)). Thepm showsettingscommand now shows these (and it shows the Django settings on... - 6 months, 2 weeks ago by Luc Saffre about #6721 (Improve docs about plugin settings) : I start to realize that maybe we do *not* want the "site settings reference" in the hosting guide. The hg can link to the dg. The site's help pages might add a generated page with all settings available on this sites.
- 6 months, 2 weeks ago by Luc Saffre about #6721 (Improve docs about plugin settings) : I realized only now that our original problem (having lino_book available for doc-testing the hosting guide) does maybe NOT require splitting the book repo. So I'll change the ticket's title.
- 6 months, 2 weeks ago by Luc Saffre about #6721 (Improve docs about plugin settings) : Created new Ticket #6721 (Split the book into "docs" and "demos").