Skip to content

Commit fd3a449

Browse files
robtaylorclaude
andcommitted
Temporarily disable AutoAPI generation due to CI import issues
AutoAPI is encountering "Unable to read file" warnings for all modules in the CI environment, preventing documentation from building. The root cause appears to be related to module import resolution in CI that does not occur locally. Changes: - Set autoapi_generate_api_docs = False in docs/conf.py - Removed duplicate ../chipflow_lib/platforms from autoapi_dirs - Removed all autoapi references from documentation files - Documentation now relies on manual API documentation in platform-api.rst This is a temporary workaround to unblock CI. AutoAPI should be re-enabled once the underlying import issues are resolved. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6e6f3e7 commit fd3a449

File tree

6 files changed

+20
-25
lines changed

6 files changed

+20
-25
lines changed

docs/architecture.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ When you run ``chipflow pin lock``:
116116
117117
The ``pins.lock`` file maps abstract interface names to concrete package pin locations:
118118

119-
.. code-block:: json
119+
.. code-block:: javascript
120120
121121
{
122122
"uart.tx": {"pin": "42", "loc": "A12"},
@@ -270,7 +270,7 @@ The annotation system is central to how ChipFlow propagates metadata:
270270

271271
Pydantic TypeAdapter generates JSON schema from TypedDict:
272272

273-
.. code-block:: json
273+
.. code-block:: javascript
274274
275275
{
276276
"$schema": "https://json-schema.org/draft/2020-12/schema",

docs/conf.py

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
'sphinx.ext.duration',
3434
'sphinx.ext.intersphinx',
3535
'sphinx.ext.napoleon',
36-
'autoapi.extension',
36+
# 'autoapi.extension', # Temporarily disabled due to CI import issues
3737
'sphinxcontrib.autoprogram',
3838
'sphinxcontrib.autodoc_pydantic',
3939
'sphinx_design',
@@ -55,24 +55,24 @@
5555

5656
autodoc_typehints = 'description'
5757

58-
autoapi_dirs = [
59-
"../chipflow_lib/platforms",
60-
"../chipflow_lib",
61-
]
62-
autoapi_generate_api_docs = True
63-
autoapi_template_dir = "_templates/autoapi"
64-
# autoapi_verbose_visibility = 2
65-
autoapi_keep_files = True
66-
autoapi_options = [
67-
'members',
68-
'show-inheritance',
69-
'show-module-summary',
70-
'imported-members',
71-
]
72-
73-
# Exclude autoapi templates and in-progress stuff
58+
# AutoAPI configuration - temporarily disabled due to CI import issues
59+
# autoapi_dirs = [
60+
# "../chipflow_lib",
61+
# ]
62+
# autoapi_generate_api_docs = False
63+
# autoapi_template_dir = "_templates/autoapi"
64+
# # autoapi_verbose_visibility = 2
65+
# autoapi_keep_files = True
66+
# autoapi_options = [
67+
# 'members',
68+
# 'show-inheritance',
69+
# 'show-module-summary',
70+
# 'imported-members',
71+
# ]
72+
73+
# Exclude in-progress stuff and template files
7474
exclude_patterns = [
75-
autoapi_template_dir,
75+
"_templates", # Exclude template files from being read as RST
7676
"unfinished",
7777
]
7878

docs/contributor-pin-signature-internals.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -779,4 +779,3 @@ See Also
779779
--------
780780

781781
- :doc:`using-pin-signatures` - User-facing guide for using pin signatures
782-
- :doc:`autoapi/chipflow_lib/platform/index` - Full platform API reference

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ It is developed at https://github.com/chipFlow/chipflow-lib/ and licensed `BSD 2
1515
chipflow-toml-guide
1616
chipflow-commands
1717
using-pin-signatures
18-
API Reference <autoapi/index>
1918
platform-api
2019

2120
.. toctree::

docs/platform-api.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ Platform API Reference
33

44
This page documents the complete public API of the ``chipflow_lib.platform`` module.
55

6-
For auto-generated documentation, see :doc:`autoapi/chipflow_lib/platform/index`.
7-
86
Re-exported Symbols
97
-------------------
108

docs/using-pin-signatures.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,5 +399,4 @@ See Also
399399
--------
400400

401401
- :doc:`chipflow-toml-guide` - Configuring your ChipFlow project
402-
- :doc:`autoapi/chipflow_lib/platform/index` - Platform API reference
403402
- :doc:`platform-api` - Complete platform API including SimPlatform and attach_data

0 commit comments

Comments
 (0)