Official release with ROP docs?

[zachriggle]

The rop module is still lacking documentation on readthedocs. Any way we can cut a new release so the docs are up?

[TethysSvensson]

Yes, with some luck, I will do a new release on Thursday. In the mean time, see http://pwntools.readthedocs.org/en/latest/

[zachriggle]

A-ha! Thanks :)

[zachriggle]

http://pwntools.readthedocs.org/en/latest/rop.html#module-pwnlib.rop :(

[TethysSvensson]

I just saw that. No idea why, but looking into it.

[TethysSvensson]

Ah. readthedocs cannot import ropgadget!

I will commit a fix soon.

[TethysSvensson]

Done. Check the link now.

[zachriggle]

Yey

[zachriggle]

Hmm, I need to work on these a bit. There's a lot of black magic that's not documented so well.

[zachriggle]

Would we be opposed to links in the docs to the pwntools-write-ups repo, or the examples directory? Some things are slightly more difficult do show useful examples for in a docstring.

Edit: I mean under a specific heading. For example, the pwnlib.tubes.ssh.ssh class has docs, but linking to a few examples would probably help. I just don't know if we want links in the docstring.

[TethysSvensson]

You can link in a function docstring if you want, but as you say it is probably better to do it in either the module docstring or in the .rst file.

[TethysSvensson]

Oh -- and in case it was not obvious: Yes, it is a good idea to link to the write up repo.