#69 - Add Python bindings API documentation#79
Conversation
Signed-off-by: Denis Leshchev <dleshchev@nvidia.com>
Signed-off-by: Denis Leshchev <dleshchev@nvidia.com>
|
| Filename | Overview |
|---|---|
| docs/api-reference/python.md | New Python bindings API reference covering init, RX/TX workflows, buffer semantics, socket/RDMA, reorder, GIL behavior, enums/classes/constants, and a full function reference table. |
| scripts/check_doc_refs.py | Extends BIN_RE negative lookahead to exclude .py file extensions, preventing Python example scripts from being false-positively matched as benchmark binaries. |
| mkdocs.yml | Nav restructured into C++/Python/Configuration YAML sub-pages. not_in_nav correctly suppresses omitted-file warnings for the compatibility stubs. |
| docs/index.html | Nav and CTA links updated; Python API Reference added to footer. Hero Language stat still reads C++ only despite Python bindings now being documented. |
| docs/api-guide.md | Converted to a backward-compatibility redirect stub pointing to the new api-reference/cpp.md location. |
| docs/configuration.md | Converted to a backward-compatibility redirect stub pointing to the new api-reference/configuration.md location. |
Comments Outside Diff (1)
-
docs/index.html, line 249 (link)Hero Language stat still reads "C++" only
The hero stats strip has
<div class="stat-value">C++</div>for the Language tile. Now that Python bindings are documented and shipped, a first-time visitor scanning the landing page will think the library is C++-only. Sincedocs/index.htmlis already being edited in this PR, changing the value toC++, Pythonhere would keep the landing page consistent with the rest of the docs.
Reviews (1): Last reviewed commit: "#69 - Update docs sync rules for API ref..." | Re-trigger Greptile
|
Closing this draft so the documentation flow can be split into a smaller docs-first PR. Keeping the branch for the later Python bindings work. |
Summary
Validation