Skip to content

Commit 00df970

Browse files
joshtynjalajoshtynjala
committed
docs.hxml
1 parent b0e06f6 commit 00df970

File tree

3 files changed

+159
-1
lines changed

3 files changed

+159
-1
lines changed

‎.github/workflows/main.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,38 @@ jobs:
1818
!.git/
1919
if-no-files-found: error
2020

21+
docs:
22+
runs-on: ubuntu-latest
23+
steps:
24+
25+
- uses: actions/checkout@v4
26+
27+
- uses: krdlab/setup-haxe@v1
28+
with:
29+
haxe-version: 4.2.5
30+
31+
- name: Set HAXEPATH
32+
run: |
33+
echo "HAXEPATH=$HAXE_STD_PATH/.." >> $GITHUB_ENV
34+
35+
- name: Install Haxe dependencies
36+
run: |
37+
haxelib install lime --quiet
38+
haxelib install openfl --quiet
39+
haxelib install dox --quiet
40+
haxelib dev svg ${{ github.workspace }}
41+
42+
- name: Build docs
43+
working-directory: scripts
44+
run: |
45+
haxe docs.hxml
46+
47+
- uses: actions/upload-artifact@v4
48+
with:
49+
name: svg-docs
50+
path: docs
51+
if-no-files-found: error
52+
2153
unit-test-hashlink:
2254
# AL init fails on both windows and ubuntu
2355
# macos-14 is arm64, which setup-haxe doesn't support yet

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@ build
44
report
55
*.html
66
generated
7-
test/bin/
7+
test/bin/
8+
docs/
9+
scripts/xml/

‎scripts/docs.hxml‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Generate platform-specific XML for documentation output
2+
3+
# -xml xml/Flash.xml
4+
# -swf obj/docs
5+
# -swf-version 17.0
6+
# -D display=usage
7+
# -D doc_gen
8+
# --macro include("starling")
9+
# -lib lime
10+
# -lib openfl
11+
# -cp ..
12+
# --no-output
13+
14+
-xml xml/Flash.xml
15+
-cpp obj/docs
16+
-D display=usage
17+
-D doc_gen
18+
-D flash_doc_gen
19+
-D nocffi
20+
--macro include("format")
21+
-lib lime
22+
-lib openfl
23+
-cp ..
24+
--no-output
25+
26+
--next
27+
28+
-xml xml/Windows.xml
29+
-cpp obj/docs
30+
-D display=usage
31+
-D windows
32+
-D doc_gen
33+
-D nocffi
34+
--macro include("format")
35+
-lib lime
36+
-lib openfl
37+
-cp ..
38+
--no-output
39+
40+
--next
41+
42+
-xml xml/macOS.xml
43+
-cpp obj/docs
44+
-D display=usage
45+
-D mac
46+
-D doc_gen
47+
-D nocffi
48+
--macro include("format")
49+
-lib lime
50+
-lib openfl
51+
-cp ..
52+
--no-output
53+
54+
--next
55+
56+
-xml xml/Linux.xml
57+
-cpp obj/docs
58+
-D display=usage
59+
-D linux
60+
-D doc_gen
61+
-D nocffi
62+
--macro include("format")
63+
-lib lime
64+
-lib openfl
65+
-cp ..
66+
--no-output
67+
68+
--next
69+
70+
-xml xml/Neko.xml
71+
-neko obj/docs
72+
-D display=usage
73+
-D doc_gen
74+
-D nocffi
75+
--macro include("format")
76+
-lib lime
77+
-lib openfl
78+
-cp ..
79+
--no-output
80+
81+
--next
82+
83+
-xml xml/iOS.xml
84+
-cpp obj/docs
85+
-D display=usage
86+
-D ios
87+
-D doc_gen
88+
-D nocffi
89+
--macro include("format")
90+
-lib lime
91+
-lib openfl
92+
-cp ..
93+
--no-output
94+
95+
--next
96+
97+
-xml xml/Android.xml
98+
-cpp obj/docs
99+
-D display=usage
100+
-D android
101+
-D doc_gen
102+
-D nocffi
103+
--macro include("format")
104+
-lib lime
105+
-lib openfl
106+
-cp ..
107+
--no-output
108+
109+
--next
110+
111+
-xml xml/HTML5.xml
112+
-js obj/docs
113+
-D display=usage
114+
-D html5
115+
-D doc_gen
116+
--macro include("format")
117+
-lib lime
118+
-lib openfl
119+
-cp ..
120+
--no-output
121+
122+
--next
123+
124+
-cmd haxelib run dox -o ../docs -i xml -in format --toplevel-package format -D website "http://www.openfl.org" -D source-path "https://github.com/openfl/svg/tree/master/src/" --title "SVG API Reference"

0 commit comments

Comments
 (0)