Skip to content

Commit 0315544

Browse files
thechenkythechenky
authored
Add automatic TypeDoc generation to Functions SDK (#491)
* add typedoc generation, somewhat working * fix from admin => functions in a comment * add npm run apidocs command to generate apidocs * modify to use modules instead of file mode * change toc to match modules mode of typedoc * add UserInfo to be generated, modify toc.yaml to correct links * add missing sections to toc.yaml * fix merge conflict * fix erroneous warnings about missing and unlisted files * remove underscores * edit toc.yaml to fix the links * remove underscores in links inside the html files * unhide Event * hide Event * add docgen/html to gitignore * formatting * remove Event from toc, add proper toc file checking * clean up docgen script
1 parent a6ef584 commit 0315544

File tree

18 files changed

+1290
-2
lines changed

18 files changed

+1290
-2
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
.tmp
44
.vscode/
55
coverage
6+
docgen/html
67
firebase-functions-*.tgz
78
integration_test/.firebaserc
89
integration_test/*.log

‎docgen/content-sources/HOME.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Firebase Functions SDK Reference
2+
3+
Functions SDK!!!

‎docgen/content-sources/toc.yaml‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
toc:
2+
- title: 'functions'
3+
path: /docs/reference/functions/cloud_functions_.html
4+
section:
5+
- title: 'CloudFunction'
6+
path: /docs/reference/functions/cloud_functions_.html#cloudfunction
7+
- title: 'HttpsFunction'
8+
path: /docs/reference/functions/cloud_functions_.html#httpsfunction
9+
- title: 'EventContext'
10+
path: /docs/reference/functions/cloud_functions_.eventcontext.html
11+
- title: 'FunctionBuilder'
12+
path: /docs/reference/functions/function_builder_.functionbuilder.html
13+
- title: 'Change'
14+
path: /docs/reference/functions/cloud_functions_.change.html
15+
16+
- title: 'functions.config'
17+
path: /docs/reference/functions/config_.html
18+
section:
19+
- title: 'Config'
20+
path: /docs/reference/functions/config_.config.html
21+
22+
- title: 'functions.analytics'
23+
path: /docs/reference/functions/providers_analytics_.html
24+
section:
25+
- title: 'AnalyticsEvent'
26+
path: /docs/reference/functions/providers_analytics_.analyticsevent.html
27+
- title: 'AnalyticsEventBuilder'
28+
path: /docs/reference/functions/providers_analytics_.analyticseventbuilder.html
29+
- title: 'AppInfo'
30+
path: /docs/reference/functions/providers_analytics_.appinfo.html
31+
- title: 'DeviceInfo'
32+
path: /docs/reference/functions/providers_analytics_.deviceinfo.html
33+
- title: 'ExportBundleInfo'
34+
path: /docs/reference/functions/providers_analytics_.exportbundleinfo.html
35+
- title: 'GeoInfo'
36+
path: /docs/reference/functions/providers_analytics_.geoinfo.html
37+
- title: 'UserDimensions'
38+
path: /docs/reference/functions/providers_analytics_.userdimensions.html
39+
- title: 'UserPropertyValue'
40+
path: /docs/reference/functions/providers_analytics_.userpropertyvalue.html
41+
42+
- title: 'functions.auth'
43+
path: /docs/reference/functions/providers_auth_.html
44+
section:
45+
- title: 'UserBuilder'
46+
path: /docs/reference/functions/providers_auth_.userbuilder.html
47+
- title: 'UserInfo'
48+
path: /docs/reference/functions/providers_auth_.html#userinfo
49+
- title: 'UserRecordMetadata'
50+
path: /docs/reference/functions/providers_auth_.userrecordmetadata.html
51+
- title: 'UserRecord'
52+
path: /docs/reference/functions/providers_auth_.html#userrecord
53+
54+
- title: 'functions.crashlytics'
55+
path: /docs/reference/functions/providers_crashlytics_.html
56+
section:
57+
- title: 'Issue'
58+
path: /docs/reference/functions/providers_crashlytics_.issue.html
59+
- title: 'IssueBuilder'
60+
path: /docs/reference/functions/providers_crashlytics_.issuebuilder.html
61+
- title: 'AppInfo'
62+
path: /docs/reference/functions/providers_crashlytics_.appinfo.html
63+
- title: 'VelocityAlert'
64+
path: /docs/reference/functions/providers_crashlytics_.velocityalert.html
65+
66+
- title: 'functions.firestore'
67+
path: /docs/reference/functions/providers_firestore_.html
68+
section:
69+
- title: 'DocumentBuilder'
70+
path: /docs/reference/functions/providers_firestore_.documentbuilder.html
71+
- title: 'DocumentSnapshot'
72+
path: /docs/reference/functions/providers_firestore_.html#documentsnapshot
73+
74+
- title: 'functions.database'
75+
path: /docs/reference/functions/providers_database_.html
76+
section:
77+
- title: 'DataSnapshot'
78+
path: /docs/reference/functions/providers_database_.datasnapshot.html
79+
- title: 'RefBuilder'
80+
path: /docs/reference/functions/providers_database_.refbuilder.html
81+
- title: 'InstanceBuilder'
82+
path: /docs/reference/functions/providers_database_.instancebuilder.html
83+
84+
- title: 'functions.https'
85+
path: /docs/reference/functions/providers_https_.html
86+
section:
87+
- title: 'HttpsError'
88+
path: /docs/reference/functions/providers_https_.httpserror.html
89+
90+
- title: 'functions.pubsub'
91+
path: /docs/reference/functions/providers_pubsub_.html
92+
section:
93+
- title: 'Message'
94+
path: /docs/reference/functions/providers_pubsub_.message.html
95+
- title: 'TopicBuilder'
96+
path: /docs/reference/functions/providers_pubsub_.topicbuilder.html
97+
98+
- title: 'functions.remoteconfig'
99+
path: /docs/reference/functions/providers_remoteconfig_.html
100+
section:
101+
- title: 'RemoteConfigUser'
102+
path: /docs/reference/functions/providers_remoteconfig_.remoteconfiguser.html
103+
- title: 'TemplateVersion'
104+
path: /docs/reference/functions/providers_remoteconfig_.templateversion.html
105+
106+
- title: 'functions.storage'
107+
path: /docs/reference/functions/providers_storage_.html
108+
section:
109+
- title: 'BucketBuilder'
110+
path: /docs/reference/functions/providers_storage_.bucketbuilder.html
111+
- title: 'ObjectBuilder'
112+
path: /docs/reference/functions/providers_storage_.objectbuilder.html
113+
- title: 'ObjectMetadata'
114+
path: /docs/reference/functions/providers_storage_.objectmetadata.html

0 commit comments

Comments
 (0)