Skip to content

Commit 3d4be18

Browse files
authored
Restructure docs into User Guide and Developer Guide streams (#367)
* Restructure docs into User Guide and Developer Guide streams - Split flat docs/ into docs/user/ (11 pages) and docs/developer/ (8 pages) - User Guide: configuration, layout, notebooks, launch, dark mode, code highlighting, git metadata, text color schemes, RTL support, stderr warnings - Developer Guide: setup, architecture, assets, testing, visual testing, release process, multilingual plan - Split oversized configure.md (587 lines) into focused topic pages - Consolidate contributing/ and CONTRIBUTING.md content into developer/ - Move PLAN_MULTILINGUAL_SUPPORT.md into developer/multilingual.md - Move RTL_SUPPORT.md into user/rtl-support.md - Add .github/workflows/docs.yml for GitHub Pages deployment - Update conf.py: nb_execution_mode=auto, exclude RTL_SUPPORT.md - Fix folium Stamen Terrain deprecation in notebooks.md - Rewrite landing page (docs/index.md) with two-stream navigation * Address Copilot review feedback - Fix missing trailing comma in sphinx_thebe extension example (launch.md) - Use npm ci instead of npm install in CI workflow (docs.yml) - Rephrase emphasis description to reference em element (text-color-schemes.md) - Fix typo: 'You an also' -> 'You can also' (notebooks.md) - Fix capitalization: 'Javascript' -> 'JavaScript' (notebooks.md)
1 parent 11991af commit 3d4be18

30 files changed

Lines changed: 2043 additions & 1830 deletions

.github/workflows/docs.yml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
# Allow only one concurrent deployment
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v6
25+
with:
26+
fetch-depth: 0 # Full history for git-based metadata
27+
28+
- name: Set up Python
29+
uses: actions/setup-python@v6
30+
with:
31+
python-version: "3.13"
32+
cache: "pip"
33+
34+
- name: Set up Node.js
35+
uses: actions/setup-node@v6
36+
with:
37+
node-version: "18"
38+
cache: "npm"
39+
40+
- name: Install Node.js dependencies and build assets
41+
run: |
42+
npm ci
43+
npm run build
44+
45+
- name: Install Python dependencies
46+
run: |
47+
python -m pip install --upgrade pip
48+
python -m pip install -e .[doc]
49+
50+
- name: Build documentation
51+
run: |
52+
sphinx-build -n --keep-going -b html docs/ docs/_build/html
53+
54+
- name: Upload artifact
55+
uses: actions/upload-pages-artifact@v3
56+
with:
57+
path: docs/_build/html
58+
59+
deploy:
60+
environment:
61+
name: github-pages
62+
url: ${{ steps.deployment.outputs.page_url }}
63+
runs-on: ubuntu-latest
64+
needs: build
65+
steps:
66+
- name: Deploy to GitHub Pages
67+
id: deployment
68+
uses: actions/deploy-pages@v4

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
# List of patterns, relative to source directory, that match files and
2929
# directories to ignore when looking for source files.
3030
# This pattern also affects html_static_path and html_extra_path.
31-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
31+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "RTL_SUPPORT.md"]
3232

3333
intersphinx_mapping = {
3434
"python": ("https://docs.python.org/3.8", None),
@@ -57,7 +57,7 @@
5757
# relative to this directory. They are copied after the builtin static files,
5858
# so a file named "default.css" will overwrite the builtin "default.css".
5959
html_static_path = ["_static"]
60-
nb_execution_mode = "cache"
60+
nb_execution_mode = "auto"
6161

6262
# -- Togglebutton configuration ----------------------------------------------
6363
togglebutton_hint = "Show"

0 commit comments

Comments
 (0)