Skip to content

Commit 26a05dd

Browse files
committed
reorganized repo and updated documentation visuals
1 parent 3798182 commit 26a05dd

327 files changed

Lines changed: 260 additions & 99 deletions

File tree

Some content is hidden

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

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion

.github/workflows/docs.yml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ jobs:
3030
with:
3131
python-version: '3.12'
3232
cache: pip
33-
cache-dependency-path: requirements-docs.txt
33+
cache-dependency-path: website/requirements-docs.txt
3434

3535
- name: Install Python docs dependencies
36-
run: pip install -r requirements-docs.txt
36+
run: pip install -r website/requirements-docs.txt
3737

3838
- name: Cache DocFX global tool
3939
uses: actions/cache@v4
@@ -50,7 +50,7 @@ jobs:
5050

5151
- name: Build API reference
5252
run: |
53-
cd Documentation~
53+
cd website/Documentation~
5454
dotnet build Mathx.Docs.csproj
5555
docfx metadata docfx.json
5656
python tools/organize_mathx_api.py
@@ -59,18 +59,19 @@ jobs:
5959
6060
- name: Stage API into docs tree
6161
run: |
62-
rm -rf docs~/api
63-
mkdir -p docs~/api
64-
cp -r Documentation~/api/_site/* docs~/api/
65-
cp docs~/api-stub/index.html docs~/api/index.html
62+
rm -rf website/docs~/api
63+
mkdir -p website/docs~/api
64+
cp -r website/Documentation~/api/_site/* website/docs~/api/
65+
cp website/docs~/api-stub/index.html website/docs~/api/index.html
6666
6767
- name: Build site
68+
working-directory: website
6869
run: mkdocs build
6970

7071
- name: Upload Pages artifact
7172
uses: actions/upload-pages-artifact@v3
7273
with:
73-
path: site~
74+
path: website/site~
7475

7576
deploy:
7677
needs: build

.github/workflows/main.yml

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ jobs:
4747
git config user.name "github-actions[bot]"
4848
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
4949
50-
CURRENT="$(jq -r '.version' package.json)"
50+
CURRENT="$(jq -r '.version' package/package.json)"
5151
if [ "$CURRENT" = "$VERSION" ]; then
5252
echo "package.json already at $VERSION"
5353
else
54-
jq --arg version "$VERSION" '.version = $version' package.json > package.json.tmp
55-
mv package.json.tmp package.json
56-
git add package.json
54+
jq --arg version "$VERSION" '.version = $version' package/package.json > package/package.json.tmp
55+
mv package/package.json.tmp package/package.json
56+
git add package/package.json
5757
git commit -m "chore: release $TAG [skip ci]"
5858
fi
5959
@@ -63,17 +63,10 @@ jobs:
6363
6464
- name: Create package archive
6565
run: |
66-
zip -r "${{ github.event.repository.name }}.zip" . \
66+
cd package
67+
zip -r "../${{ github.event.repository.name }}.zip" . \
6768
-x "*.git*" \
68-
-x ".github/*" \
69-
-x ".cursorignore" \
70-
-x "Tests/*" \
71-
-x "Documentation~/*" \
72-
-x "docs~/*" \
73-
-x "overrides~/*" \
74-
-x "mkdocs.yml" \
75-
-x "requirements-docs.txt" \
76-
-x "site~/*"
69+
-x "Tests/*"
7770
7871
- name: Create GitHub Release
7972
uses: softprops/action-gh-release@v2

.gitignore

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
*.csproj
2-
!Documentation~/**/*.csproj
2+
!website/Documentation~/**/*.csproj
33
*.csproj.meta
44

5-
# Documentation builds (~ suffix = Unity ignores folder on import)
6-
site~/
7-
docs~/api/
8-
docs.meta
9-
overrides.meta
10-
site.meta
11-
Documentation~/api/
12-
Documentation~/**/*.meta
13-
Documentation~/**/bin/
14-
Documentation~/**/obj/
15-
Documentation~/**/*.dll
16-
Documentation~/**/*.pdb
17-
Documentation~/**/*.deps.json
18-
Documentation~/**/obj/**/*.cs
19-
Documentation~/**/obj/**/*.cache
20-
Documentation~/**/obj/**/*.editorconfig
21-
Documentation~/**/obj/**/*.txt
5+
# Documentation builds
6+
website/site~/
7+
website/docs~/api/
8+
website/Documentation~/api/
9+
website/Documentation~/**/*.meta
10+
website/Documentation~/**/bin/
11+
website/Documentation~/**/obj/
12+
website/Documentation~/**/*.dll
13+
website/Documentation~/**/*.pdb
14+
website/Documentation~/**/*.deps.json
15+
website/Documentation~/**/obj/**/*.cs
16+
website/Documentation~/**/obj/**/*.cache
17+
website/Documentation~/**/obj/**/*.editorconfig
18+
website/Documentation~/**/obj/**/*.txt

README.md

Lines changed: 13 additions & 8 deletions
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)