Skip to content

Commit 30fdcbc

Browse files
committed
Fix module index 404 and enhance documentation
- Add comprehensive Python module index (py-modindex.html) - Add detailed OrderBook API documentation with Level 2 features - Fix GitHub Actions environment configuration for Pages deployment - Add automodule directives for proper module indexing - Update all API documentation with enhanced content - Fix import issues in main __init__.py - Update version to 0.3.0 in documentation
1 parent 5afe2e2 commit 30fdcbc

File tree

12 files changed

+686
-18
lines changed

12 files changed

+686
-18
lines changed

.github/workflows/docs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,10 @@ jobs:
8282
pages: write # to deploy to Pages
8383
id-token: write # to verify the deployment originates from an appropriate source
8484

85-
85+
# Configure environment for GitHub Pages deployment
86+
environment:
87+
name: github-pages
88+
url: ${{ steps.deployment.outputs.page_url }}
8689

8790
steps:
8891
- name: Download documentation artifacts

docs/api/client.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ ProjectX Client
88

99
.. currentmodule:: project_x_py
1010

11+
.. automodule:: project_x_py.client
12+
:members:
13+
:undoc-members:
14+
:show-inheritance:
15+
:no-index:
16+
1117
.. autoclass:: ProjectX
1218
:members:
1319
:undoc-members:

docs/api/data.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,13 @@ Real-time Client
2424
Orderbook Analysis
2525
------------------
2626

27+
.. note::
28+
**Level 2 OrderBook API**: For comprehensive Level 2 orderbook analysis including
29+
iceberg detection, market imbalance analysis, and institutional-grade market
30+
microstructure tools, see the dedicated :doc:`orderbook` module.
31+
2732
.. autoclass:: OrderBook
28-
:members:
29-
:undoc-members:
33+
:members: get_orderbook_snapshot, get_best_bid_ask, get_advanced_market_metrics
3034
:show-inheritance:
3135

3236
Data Factory Functions

docs/api/indicators.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ The indicators module provides both class-based and function-based interfaces fo
1010

1111
.. currentmodule:: project_x_py.indicators
1212

13+
.. automodule:: project_x_py.indicators
14+
:members:
15+
:undoc-members:
16+
:show-inheritance:
17+
:no-index:
18+
1319
Quick Start
1420
-----------
1521

docs/api/models.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ Core Models
88

99
.. currentmodule:: project_x_py.models
1010

11+
.. automodule:: project_x_py.models
12+
:members:
13+
:undoc-members:
14+
:show-inheritance:
15+
:no-index:
16+
1117
Configuration
1218
~~~~~~~~~~~~~
1319

0 commit comments

Comments
 (0)