Add listing/glossary of the tools to our documentation

haddocking / pdb-tools

A dependency-free cross-platform swiss army knife for PDB files.

https://haddocking.github.io/pdb-tools/

Apache License 2.0

378 stars 113 forks source link

Add listing/glossary of the tools to our documentation #24

Closed JoaoRodrigues closed 4 years ago

JoaoRodrigues commented 5 years ago

It could be useful to have a list of all the tools we have and a very small description (even pulled directly from their own documentation), so that people can see quickly what's out there.

mtrellet commented 5 years ago

We could have a look at this project to automate things a bit: https://github.com/NiklasRosenstein/pydoc-markdown

Of course sphinx does it quite nicely as well but I'm not sure it does combine well with jekyll and I'm not sure we want to go down that way either...

JoaoRodrigues commented 4 years ago

Fixed by #45, #46, and #47 !

joaomcteixeira commented 4 years ago

Hehe, just for fun on pulling docstrings automatically, @mtrellet @JoaoRodrigues

a long time ago I did this using recursion as an exercise. I don't even recall in which state I left it :thinking:

https://github.com/joaomcteixeira/HyperSimpleDocstring2Md

JoaoRodrigues commented 4 years ago

Oh now you tell me...

mtrellet commented 4 years ago

Oh super nice @joaomcteixeira , I steal that!

Sorry for you @JoaoRodrigues ...

joaomcteixeira commented 4 years ago

Oh now you tell me...

you were too fast on the PRs :100:

@mtrellet c00l! Thx! I don't recall well the state of it, but it was working. Have a look let me know you feedback. Last commit 15 months go :fallen_leaf: