Skip to content

Commit b20ffef

Browse files
farhanclaude
farhan
and
claude
committed
fix: resolve tox -e docs failures
- Mock chdb at autodoc time (fails to initialize on macOS) - Add -f to sphinx-apidoc so stale RST files are overwritten on each build - Remove unsupported logo_only theme option from sphinx_book_theme - Fix get_config docstring RST indentation (unexpected indent warning) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent b50cf32 commit b20ffef

8 files changed

Lines changed: 244 additions & 31 deletions

File tree

‎docs/conf.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@
5353
"image.nonlocal_uri",
5454
]
5555

56+
# Mock imports that fail at module level in the docs environment.
57+
autodoc_mock_imports = ["chdb"]
58+
5659
# Add any paths that contain templates here, relative to this directory.
5760
templates_path = ["_templates"]
5861

@@ -170,7 +173,6 @@
170173
"repository_url": "https://github.com/openedx/xapi-db-load",
171174
"repository_branch": "main",
172175
"path_to_docs": "docs/",
173-
"logo_only": True,
174176
"home_page_in_toc": True,
175177
"use_repository_button": True,
176178
"use_issues_button": True,
@@ -521,7 +523,7 @@ def on_init(app): # pylint: disable=unused-argument
521523
# If we are, assemble the path manually
522524
bin_path = os.path.abspath(os.path.join(sys.prefix, "bin"))
523525
apidoc_path = os.path.join(bin_path, apidoc_path)
524-
check_call([apidoc_path, "-o", docs_path, os.path.join(root_path, "xapi_db_load")])
526+
check_call([apidoc_path, "-f", "-o", docs_path, os.path.join(root_path, "xapi_db_load")])
525527

526528

527529
def setup(app):

‎docs/xapi_db_load.backends.rst‎

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,58 @@ xapi\_db\_load.backends package
44
Submodules
55
----------
66

7-
xapi\_db\_load.backends.citus\_lake module
8-
------------------------------------------
7+
xapi\_db\_load.backends.base\_async\_backend module
8+
---------------------------------------------------
99

10-
.. automodule:: xapi_db_load.backends.citus_lake
10+
.. automodule:: xapi_db_load.backends.base_async_backend
1111
:members:
12-
:undoc-members:
1312
:show-inheritance:
13+
:undoc-members:
1414

15-
xapi\_db\_load.backends.clickhouse\_lake module
16-
-----------------------------------------------
15+
xapi\_db\_load.backends.chdb module
16+
-----------------------------------
1717

18-
.. automodule:: xapi_db_load.backends.clickhouse_lake
18+
.. automodule:: xapi_db_load.backends.chdb
1919
:members:
20-
:undoc-members:
2120
:show-inheritance:
21+
:undoc-members:
2222

23-
xapi\_db\_load.backends.mongo\_lake module
24-
------------------------------------------
23+
xapi\_db\_load.backends.clickhouse module
24+
-----------------------------------------
2525

26-
.. automodule:: xapi_db_load.backends.mongo_lake
26+
.. automodule:: xapi_db_load.backends.clickhouse
2727
:members:
28+
:show-inheritance:
2829
:undoc-members:
30+
31+
xapi\_db\_load.backends.csv module
32+
----------------------------------
33+
34+
.. automodule:: xapi_db_load.backends.csv
35+
:members:
2936
:show-inheritance:
37+
:undoc-members:
3038

31-
xapi\_db\_load.backends.ralph\_lrs module
32-
-----------------------------------------
39+
xapi\_db\_load.backends.ralph module
40+
------------------------------------
3341

34-
.. automodule:: xapi_db_load.backends.ralph_lrs
42+
.. automodule:: xapi_db_load.backends.ralph
3543
:members:
44+
:show-inheritance:
3645
:undoc-members:
46+
47+
xapi\_db\_load.backends.vector module
48+
-------------------------------------
49+
50+
.. automodule:: xapi_db_load.backends.vector
51+
:members:
3752
:show-inheritance:
53+
:undoc-members:
3854

3955
Module contents
4056
---------------
4157

4258
.. automodule:: xapi_db_load.backends
4359
:members:
44-
:undoc-members:
4560
:show-inheritance:
61+
:undoc-members:

‎docs/xapi_db_load.fixtures.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
xapi\_db\_load.fixtures package
2+
===============================
3+
4+
Submodules
5+
----------
6+
7+
xapi\_db\_load.fixtures.music\_tags module
8+
------------------------------------------
9+
10+
.. automodule:: xapi_db_load.fixtures.music_tags
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: xapi_db_load.fixtures
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:

‎docs/xapi_db_load.rst‎

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,74 @@ Subpackages
88
:maxdepth: 4
99

1010
xapi_db_load.backends
11+
xapi_db_load.fixtures
12+
xapi_db_load.tests
13+
xapi_db_load.ui
1114
xapi_db_load.xapi
1215

1316
Submodules
1417
----------
1518

19+
xapi\_db\_load.async\_app module
20+
--------------------------------
21+
22+
.. automodule:: xapi_db_load.async_app
23+
:members:
24+
:show-inheritance:
25+
:undoc-members:
26+
27+
xapi\_db\_load.constants module
28+
-------------------------------
29+
30+
.. automodule:: xapi_db_load.constants
31+
:members:
32+
:show-inheritance:
33+
:undoc-members:
34+
1635
xapi\_db\_load.course\_configs module
1736
-------------------------------------
1837

1938
.. automodule:: xapi_db_load.course_configs
2039
:members:
21-
:undoc-members:
2240
:show-inheritance:
41+
:undoc-members:
2342

24-
xapi\_db\_load.generate\_load module
25-
------------------------------------
43+
xapi\_db\_load.generate\_load\_async module
44+
-------------------------------------------
2645

27-
.. automodule:: xapi_db_load.generate_load
46+
.. automodule:: xapi_db_load.generate_load_async
2847
:members:
29-
:undoc-members:
3048
:show-inheritance:
49+
:undoc-members:
3150

3251
xapi\_db\_load.main module
3352
--------------------------
3453

3554
.. automodule:: xapi_db_load.main
3655
:members:
56+
:show-inheritance:
3757
:undoc-members:
58+
59+
xapi\_db\_load.runner module
60+
----------------------------
61+
62+
.. automodule:: xapi_db_load.runner
63+
:members:
3864
:show-inheritance:
65+
:undoc-members:
66+
67+
xapi\_db\_load.waiter module
68+
----------------------------
69+
70+
.. automodule:: xapi_db_load.waiter
71+
:members:
72+
:show-inheritance:
73+
:undoc-members:
3974

4075
Module contents
4176
---------------
4277

4378
.. automodule:: xapi_db_load
4479
:members:
45-
:undoc-members:
4680
:show-inheritance:
81+
:undoc-members:

‎docs/xapi_db_load.tests.rst‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
xapi\_db\_load.tests package
2+
============================
3+
4+
Submodules
5+
----------
6+
7+
xapi\_db\_load.tests.test\_backends module
8+
------------------------------------------
9+
10+
.. automodule:: xapi_db_load.tests.test_backends
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
xapi\_db\_load.tests.test\_config module
16+
----------------------------------------
17+
18+
.. automodule:: xapi_db_load.tests.test_config
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
xapi\_db\_load.tests.test\_event\_generator module
24+
--------------------------------------------------
25+
26+
.. automodule:: xapi_db_load.tests.test_event_generator
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
xapi\_db\_load.tests.test\_ui module
32+
------------------------------------
33+
34+
.. automodule:: xapi_db_load.tests.test_ui
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:
38+
39+
xapi\_db\_load.tests.test\_waiter module
40+
----------------------------------------
41+
42+
.. automodule:: xapi_db_load.tests.test_waiter
43+
:members:
44+
:show-inheritance:
45+
:undoc-members:
46+
47+
xapi\_db\_load.tests.test\_xapi\_events module
48+
----------------------------------------------
49+
50+
.. automodule:: xapi_db_load.tests.test_xapi_events
51+
:members:
52+
:show-inheritance:
53+
:undoc-members:
54+
55+
xapi\_db\_load.tests.utils module
56+
---------------------------------
57+
58+
.. automodule:: xapi_db_load.tests.utils
59+
:members:
60+
:show-inheritance:
61+
:undoc-members:
62+
63+
Module contents
64+
---------------
65+
66+
.. automodule:: xapi_db_load.tests
67+
:members:
68+
:show-inheritance:
69+
:undoc-members:

‎docs/xapi_db_load.ui.rst‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
xapi\_db\_load.ui package
2+
=========================
3+
4+
Submodules
5+
----------
6+
7+
xapi\_db\_load.ui.config\_ui module
8+
-----------------------------------
9+
10+
.. automodule:: xapi_db_load.ui.config_ui
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
xapi\_db\_load.ui.load\_ui module
16+
---------------------------------
17+
18+
.. automodule:: xapi_db_load.ui.load_ui
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
xapi\_db\_load.ui.log\_ui module
24+
--------------------------------
25+
26+
.. automodule:: xapi_db_load.ui.log_ui
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
xapi\_db\_load.ui.main\_ui module
32+
---------------------------------
33+
34+
.. automodule:: xapi_db_load.ui.main_ui
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:
38+
39+
xapi\_db\_load.ui.text\_ui module
40+
---------------------------------
41+
42+
.. automodule:: xapi_db_load.ui.text_ui
43+
:members:
44+
:show-inheritance:
45+
:undoc-members:
46+
47+
xapi\_db\_load.ui.themes module
48+
-------------------------------
49+
50+
.. automodule:: xapi_db_load.ui.themes
51+
:members:
52+
:show-inheritance:
53+
:undoc-members:
54+
55+
Module contents
56+
---------------
57+
58+
.. automodule:: xapi_db_load.ui
59+
:members:
60+
:show-inheritance:
61+
:undoc-members:

0 commit comments

Comments
 (0)