Skip to content

Commit 350f5bb

Browse files
authored
docs: relocate website to docs/website/, add GitHub Actions deployment (#557)
Separates website files from non-website documentation: - Move all website content (api/, articles/, styles/, fonts/, images/, index.html, etc.) to docs/website/ - Keep docs/issues/ and docs/plans/ at docs/ root - Add .github/workflows/docs.yml for GitHub Actions Pages deployment - Update docfx_project/docfx.json to output to docs/website/ The new workflow deploys from docs/website/ using actions/deploy-pages, replacing the legacy "Deploy from a branch" approach which only supports / or /docs paths. Post-merge: Change GitHub Pages source to "GitHub Actions" in repo settings. Closes #556
1 parent f4e04f6 commit 350f5bb

File tree

98 files changed

+40
-1
lines changed

Some content is hidden

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

98 files changed

+40
-1
lines changed

.github/workflows/docs.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches: ["master", "main"]
6+
paths:
7+
- 'docs/website/**'
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
deploy:
21+
environment:
22+
name: github-pages
23+
url: ${{ steps.deployment.outputs.page_url }}
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
29+
- name: Setup Pages
30+
uses: actions/configure-pages@v5
31+
32+
- name: Upload artifact
33+
uses: actions/upload-pages-artifact@v3
34+
with:
35+
path: 'docs/website'
36+
37+
- name: Deploy to GitHub Pages
38+
id: deployment
39+
uses: actions/deploy-pages@v4

docfx_project/docfx.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
]
5050
}
5151
],
52-
"dest": ".",
52+
"dest": "../docs/website",
5353
"globalMetadataFiles": [],
5454
"fileMetadataFiles": [],
5555
"template": [

docs/api/NumSharp.Core.Extensions.NDArrayExtensions.html renamed to docs/website/api/NumSharp.Core.Extensions.NDArrayExtensions.html

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)