astroid icon indicating copy to clipboard operation
astroid copied to clipboard

Listing all default keybindings in documentation?

Open kirschner opened this issue 8 years ago • 6 comments

A minor point I realised. In the documentation https://github.com/astroidmail/astroid/wiki/Customizing-key-bindings it is written that you can generate a list of all keybindings with the devel/get_keys.py script.

I was wondering if there would be an easy way to generate this list automatically for the documentation, so users do not have to run this script, but can check all default keybindings in the online documentation.

kirschner avatar Apr 18 '17 18:04 kirschner

Would be nice. The problem is that the keybindings may change once in a while and that the wiki is in another git repository than astroid (so I see no way how to make this possible with a git hook).

One possibility would be to create a default keybindings file automatically with each astroid build, e.g. that scons runs devel/get-keys.py > ~/.config/astroid/keybindings.orig.

mxmehl avatar Apr 18 '17 19:04 mxmehl

Max writes on april 18, 2017 21:12:

Would be nice. The problem is that the keybindings may change once in a while and that the wiki is in another git repository than astroid (so I see no way how to make this possible with a git hook).

One possibility would be to create a default keybindings file automatically with each astroid build, e.g. that scons runs devel/get-keys.py > ~/.config/astroid/keybindings.orig.

Yes, this is a possibility, or we might be able to set up some hook on github that does this automatically.

gauteh avatar Apr 19 '17 06:04 gauteh

Hello @gauteh. Run into the issue again to find out some keybindings (had to find out what keys are still available for own shortcuts). Any chance the solution by @mxmehl or a hook can be implemented? Thank you!

kirschner avatar Feb 22 '21 20:02 kirschner

@kirschner there's a script under devel/ you can run that will extract all the available commands and their default bindings from the source.

j-hui avatar Feb 27 '21 06:02 j-hui

@j-hui Yes, I know that. The idea was that users who do not have the devel/ files on their machines also can see the keybindings (as it is part of the documentation then). For the distribution packages that would be helpful from my perspective.

kirschner avatar Mar 17 '21 07:03 kirschner

That would be useful, can probably be made part of the build process somehow.

On Wed, Mar 17, 2021 at 8:47 AM Matthias Kirschner @.***> wrote:

@j-hui https://github.com/j-hui Yes, I know that. The idea was that users who do not have the devel/ files on their machines also can see the keybindings (as it is part of the documentation then). For the distribution packages that would be helpful from my perspective.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/astroidmail/astroid/issues/323#issuecomment-800872290, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAN36YFV6CB4UDZQBYTFN3TEBNCHANCNFSM4DIC7TNA .

gauteh avatar Mar 17 '21 08:03 gauteh