Commit graph

8 commits

Author SHA1 Message Date
Kevin Phoenix
7fd4ac3bf9
docs: Auto-generate the API reference via autosummary (#6460)
Replace the hand-maintained ``api.rst`` listing with a single
``.. autosummary:: :recursive:`` entry point, and add an autosummary
template under ``_templates/autosummary/module.rst`` that recursively
emits a page per submodule. The output directory ``docs/api/`` is
gitignored.

The template uses ``.. rubric:: Submodules`` instead of a section
heading so the autogenerated pages don't all register a duplicate
"Submodules" autosectionlabel.

Adjustments to ``conf.py`` to make the auto-generated pages readable:

- ``autodoc_class_signature = "separated"`` so the class declaration line
  does not duplicate the ``__init__`` parameter list.
- ``skip_inherited_undocumented`` (autodoc-skip-member): when a subclass
  overrides a method without its own docstring, do not document the
  override on the subclass page; the parent's "Bases:" link already
  points readers to the canonical entry. Avoids duplicating the parent's
  full docstring on every subclass.
- ``_patch_directive_header_for_reexports`` (monkey-patch of
  ``_directive_header_lines``): for re-exported symbols (e.g.
  ``angr.SimState`` re-exporting ``angr.sim_state.SimState``), inject
  ``:no-index:`` so the entry still renders on the parent page but the
  canonical defining-module page is the unambiguous cross-reference
  target.
2026-06-04 08:32:27 -07:00
Kevin Phoenix
94823fb6b4
Remove symbion remnants (#5649) 2025-09-08 17:10:47 -07:00
Matt Borgerson
486985ba1a docs: Add AIL modules 2025-05-28 16:00:42 -07:00
Audrey Dutcher
43d3d81c82
Aggressively polish RDA APIs (#4088)
* Aggressively polish the RDA deref and get_concrete_value apis

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add load-from-loader-memory code path for rda memory loads

* RDA: FunctionCallDataUnwrapped, reset_prototype, and many interfaces now take more types

* Types; imports; other atoms

* lmao

* New overload for definition filters + new behavior for generating external definitions

* weh

* Add extract and concat to multivalues; make multivalues not choke on zero-length bitvectors

* Additional finagling for multivalues; match extern definitions

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* oopsie whoopsie

* lint

* lint harder

* rename only -> one

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-08-28 20:35:39 -07:00
Fish
7919015258
VRA: Pre-scan to determine narrowing targets to avoid changing immutable objects. (#3935)
* VRA: Pre-scan to determine narrowing targets to avoid changing immutable objects.

* Lint code.
2023-05-06 20:01:17 -07:00
Audrey Dutcher
90dd9268ad
Add some new interfaces for propagator; reorganize code (#3874)
* do a heckin propagation

* Move merge_replacements to PropagatorState.

* apply a missed patch

* Enormous weh

* Replace CFGUtils with GraphUtils.

* Update api-doc

* Fix VFG base type.

* Lint code.

---------

Co-authored-by: Fish <fishw@asu.edu>
2023-04-23 14:46:09 -07:00
Kevin Phoenix
10cf2ad2a0
Port gitbook docs to sphinx (#3865)
* Port gitbook docs to sphinx

* Some fixes
2023-03-17 15:44:35 -07:00
Kevin Phoenix
5051023056
Add in-tree docs (#3849)
* Add in-tree docs

* Add build dependencies to RTD build

* Also install newer pip

* Install angrdb and pcode when building docs

* Sync ci docs with rtd config

* Use pipe for multiline string

* Fix typo

* Replace copyright with project_copyright

* Ignore type aliases in sphinx coverage

* Add links to plugin documentation

* Use coverage_ignore_pyobjects to ignore aliases

* Attribute copyright to contributors
2023-03-08 18:06:10 -07:00