Commit Graph

2 Commits

Author SHA1 Message Date
k4lizen 52a4be5e50
Improve convenience function helps and autogenerate documentation (#2900)
* expand and add examples to pwndbg convenience functions

* update usage descriptions in _gen_*

* refactor out some common logic

* implement function doc generation

* change some mkdocs defaults around to be better for the general case

* generate function docs

* cleanup some examples, help, and quote escaping explanation

* move fsbase and gsbase definitions (and use decorator)

* cleanup signature for fsbase and gsbase

* autogen functions

* type annotation

* fix ida and binja descriptions

* rename arguments, reorder docs for `help function` and assert convention

* add missing imports

* use inspect.getdoc instead of directly accessing __doc__

for more consistency across python versions

* regen docs with getdoc()

* rewire exit and lint

* let users know about convenience functions through the `pwndbg` command

* sys.exit instead of exit
2025-04-26 11:49:33 +02:00
k4lizen 486ce78c08
Cleanup parameters and autogenerate doc pages for them (#2875)
* make parameter scope an enum

* brighter code text, smaller top-margins for level 2 headings

* cleanup configuration logic, add assertions

* add script for generating configuration docs, move out some common logic

* move heap-config to pwndbg category since it should encompass other allocators as well

* docs update for heap-config move

* don't annotate code blocks with line numbers; add ability to use github flavoured markdown-type tasklist

* hand write configuration index, auto generate other docs

oops the auto-generated docs/commands/index.md change is in this commit

* fix bug of discarding help_docstring

* auto-gen docs for previous bugfix

* make parameter help's work with markdown

* autogen docs again

* add scripts to lint and lint them

* import missing stuff

* update docs-live script

* fixups

* update docs
2025-04-18 13:13:16 +02:00