Skip to content

Commit 2e64219

Browse files
TexasCodingclaude
andcommitted
docs: migrate from Sphinx to MkDocs documentation system
- Replace Sphinx with MkDocs using Material theme - Add comprehensive documentation structure with guides and API reference - Create user guides for trading suite, orders, positions, indicators - Include development documentation for contributors - Add migration guides for version upgrades - Configure GitHub Actions for automated docs deployment - Remove legacy Sphinx documentation files - Add pragma comments for false positive secret detection - Set up deployment scripts for documentation hosting 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent cfd50fa commit 2e64219

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+19835
-6651
lines changed

.github/workflows/docs.yml

Lines changed: 11 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ on:
77
- 'docs/**'
88
- 'src/**'
99
- '.github/workflows/docs.yml'
10+
- 'mkdocs.yml'
1011
- 'pyproject.toml'
1112
pull_request:
1213
branches: [ main ]
1314
paths:
1415
- 'docs/**'
1516
- 'src/**'
1617
- '.github/workflows/docs.yml'
18+
- 'mkdocs.yml'
1719
- 'pyproject.toml'
1820

1921
# Add permissions for GitHub Pages deployment
@@ -38,39 +40,24 @@ jobs:
3840
- name: Install dependencies
3941
run: |
4042
python -m pip install --upgrade pip
41-
pip install -e .[docs]
43+
pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-jupyter pymdown-extensions
44+
pip install -e .
4245
43-
- name: Check documentation coverage
46+
- name: Build documentation
4447
run: |
45-
cd docs
46-
make coverage
48+
mkdocs build --strict --verbose
4749
4850
- name: Check for broken links
4951
run: |
50-
cd docs
51-
make linkcheck
52+
pip install linkchecker
53+
linkchecker site/
5254
continue-on-error: true # Don't fail build on broken external links
5355

54-
- name: Build documentation
55-
run: |
56-
cd docs
57-
make html
58-
59-
- name: Check build warnings
60-
run: |
61-
cd docs
62-
if [ -s _build/html/.doctrees/warnings.txt ]; then
63-
echo "Documentation build has warnings:"
64-
cat _build/html/.doctrees/warnings.txt
65-
exit 1
66-
fi
67-
continue-on-error: true
68-
6956
- name: Upload documentation artifacts
7057
uses: actions/upload-artifact@v4
7158
with:
7259
name: documentation
73-
path: docs/_build/html/
60+
path: site/
7461

7562
deploy-docs:
7663
runs-on: ubuntu-latest
@@ -92,29 +79,16 @@ jobs:
9279
uses: actions/download-artifact@v4
9380
with:
9481
name: documentation
95-
path: docs/_build/html/
82+
path: site/
9683

9784
- name: Setup Pages
9885
uses: actions/configure-pages@v4
9986

10087
- name: Upload to GitHub Pages
10188
uses: actions/upload-pages-artifact@v3
10289
with:
103-
path: docs/_build/html/
90+
path: site/
10491

10592
- name: Deploy to GitHub Pages
10693
id: deployment
10794
uses: actions/deploy-pages@v4
108-
109-
readthedocs-webhook:
110-
runs-on: ubuntu-latest
111-
needs: build-docs
112-
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
113-
114-
steps:
115-
- name: Trigger ReadTheDocs build
116-
run: |
117-
curl -X POST \
118-
-H "Authorization: Token ${{ secrets.READTHEDOCS_TOKEN }}" \
119-
https://readthedocs.org/api/v3/projects/project-x-py/builds/
120-
continue-on-error: true # Don't fail if webhook isn't configured
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0 # Fetch all history for git info
26+
27+
- name: Setup Python
28+
uses: actions/setup-python@v4
29+
with:
30+
python-version: '3.12'
31+
32+
- name: Install dependencies
33+
run: |
34+
python -m pip install --upgrade pip
35+
pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-jupyter
36+
pip install pymdown-extensions mkdocs-autorefs mkdocs-gen-files
37+
pip install mkdocs-literate-nav mkdocs-section-index mike
38+
pip install -e .
39+
40+
- name: Build documentation
41+
run: mkdocs build
42+
43+
- name: Setup Pages
44+
uses: actions/configure-pages@v4
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: 'site'
50+
51+
deploy:
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
runs-on: ubuntu-latest
56+
needs: build
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

.readthedocs.yml

Lines changed: 0 additions & 33 deletions
This file was deleted.

docs/Makefile

Lines changed: 0 additions & 39 deletions
This file was deleted.

0 commit comments

Comments
 (0)