Skip to content

Commit 83ce988

Browse files
committed
Add explicit documentation for re-exported platform symbols
Added platform-api.rst to document SimPlatform and attach_data which are re-exported from submodules but weren't appearing in the main autoapi index due to sphinx-autoapi limitations with imported members. This provides users with complete documentation coverage of the public platform API.
1 parent 53eda31 commit 83ce988

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ It is developed at https://github.com/chipFlow/chipflow-lib/ and licensed `BSD 2
1313
chipflow-toml-guide
1414
chipflow-commands
1515
API Reference <autoapi/index>
16+
platform-api

docs/platform-api.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Platform API Reference
2+
======================
3+
4+
This page documents the complete public API of the ``chipflow_lib.platform`` module.
5+
6+
For auto-generated documentation, see :doc:`autoapi/chipflow_lib/platform/index`.
7+
8+
Re-exported Symbols
9+
-------------------
10+
11+
The following symbols are re-exported from submodules for convenience:
12+
13+
.. autoclass:: chipflow_lib.platform.sim.SimPlatform
14+
:members:
15+
:undoc-members:
16+
17+
.. autofunction:: chipflow_lib.platform.io.signatures.attach_data

0 commit comments

Comments
 (0)