#4172 (End-user help for demo sites (makehelp))
by Luc Saffre · in Developers · assigned to Luc Saffre
Résumé
Concepts sous-jacents
Commentaires
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : Uff, this was easy: welcht didn't yet yield lino.modlib.help in its get_installed_apps().
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : Ouch, there are more failures caused by this ticket in the welfare test suite.
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : The Site startup is documented [url dev.lino-framework.org/dev/startup.html here], but this page is partly obsolete...
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : Yes, my guess was true. So I had to create yet another startup hook method Plugin.before_actors_discover(). The startup process is complex and will always remain so...
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : The docs/specs/avanti/avanti.rst doctest is still failing because help_text of Person is None. I guess it is because virtual fields get cloned from the mixin, and the before_analyze() is called after this cloning. Working on it.
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : I committed my work because now it looks okay. But the book test suite doesn't finish because it hangs in docs/specs/getlino/startproject.rst. This is for you, Sharif.
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : The test suite on my computer showed multiple failures and got stuck somewhere. So I restarted it again (this time --verbose) and hope that I can commit before we leave.
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : I moved all the help functionality, including the OpenHelpWindow action to a new plugin lino.modlib.help. Renamed makedocs to makehelp.
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : I fixed some failures in the test suites that were introduced by my recent changes.
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : I wrote more documentation and now -finally- committed my work. A summary is [url luc.lino-framework.org/blog/2021/0709.html in my blog]. Before closing this ticket, I'd like to move all this help stuff into a separate (optional) plugin.
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : I still didn't yet commit because I started to write documentation and had more ideas.
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : I started to run the test suites and plan to commit my work soon. There are some visible improvements... I moved the logic for loading help texts at startup into a separate class lino.core.help.HelpTextsLoader(), which is instantiated temporarily by the kernel. The makedocs command instantiates it a...
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : There is much to do, but I am advancing... and I think it will be indeed an important fundamental improvement for the end-user docs.
- 5 ans, 3 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : I reactivated this because the whole user guide depends on the site docs.
- 5 ans, 4 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : I worked on makedocs : the actor page is now less empty. Not yet published.
- 5 ans, 4 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : The new action is in the python code, and it appears already in the toolbar, but is not yet clickable. We added a new method Action.get_a_href_target(), which is to be called by the renderer (when rendering the JS cache files) and usually returns None. When it returns a string, Lino should treat it ...
- 5 ans, 4 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : Sharif and I are adding a help button to every toolbar.
- 5 ans, 5 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : I discovered a ten year old admin command (lino.management.commands.makedocs) that did quite exactly the same thing. It had been sleeping there and of course needed a big rewrite. It still used Cheetah templates. It now generates already a set of rst files. Next step is to generate them for each lan...
- 5 ans, 5 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : My vision is to extend Django's collectstatic command so that it would (optionally) write a series of Sphinx source files to a temporary directory and then run sphinx-build on this doctree. Every Lino site would (optionally) have its own user guide. The content of this local user guide would be gene...
- 5 ans, 5 mois ago by Luc Saffre about #4172 (End-user help for demo sites (makehelp)) : The demo sites should have tutorials and end-user documentation about how to use them. Also some form of tips (*"Did you know?"), and these tips should be able to link into the user docs.