Skip to content

Commit d88fd1f

Browse files
committed
Add built docs to repo to support gh-pages
1 parent a3b972d commit d88fd1f

File tree

175 files changed

+49455
-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.

175 files changed

+49455
-1
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
# compiled output
44
/dist
5-
/docs
65
/tmp
76

87
# dependencies

docs/api.js

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
YUI.add("yuidoc-meta", function(Y) {
2+
Y.YUIDoc = { meta: {
3+
"classes": [
4+
"CasAuthenticatedRouteMixin",
5+
"Collection",
6+
"Comment",
7+
"CommentReport",
8+
"CommentableMixin",
9+
"Contributor",
10+
"DraftRegistration",
11+
"FetchAllRouteMixin",
12+
"File",
13+
"FileCacheBypassMixin",
14+
"FileItemMixin",
15+
"FileProvider",
16+
"FileVersion",
17+
"GenericDataADapter",
18+
"InfinityCustomMixin",
19+
"Institution",
20+
"Log",
21+
"Metaschema",
22+
"Node",
23+
"NodeActionsMixin",
24+
"NodeLink",
25+
"OsfAdapter",
26+
"OsfAgnosticAuthController",
27+
"OsfAgnosticAuthRoute",
28+
"OsfCookieAuthenticator",
29+
"OsfCookieAuthorizer",
30+
"OsfCookieLoginController",
31+
"OsfCookieLoginRoute",
32+
"OsfModel",
33+
"OsfSerializer",
34+
"OsfTokenAuthenticator",
35+
"OsfTokenAuthorizer",
36+
"OsfTokenLoginControllerMixin",
37+
"OsfTokenLoginRouteMixin",
38+
"PaginatedControllerMixin",
39+
"PaginatedRouteMixin",
40+
"Preprint",
41+
"Registration",
42+
"RegistrationActionsMixin",
43+
"TaggableMixin",
44+
"Taxonomy",
45+
"User",
46+
"ajax-helpers",
47+
"auth",
48+
"comment-detail",
49+
"comment-form",
50+
"comment-pane",
51+
"current-user",
52+
"dropzone-widget",
53+
"elem-id",
54+
"eosf-project-nav",
55+
"file-browser",
56+
"file-browser-icon",
57+
"file-chooser component",
58+
"file-manager",
59+
"file-renderer",
60+
"file-version",
61+
"file-widget",
62+
"oauth-popup",
63+
"osf-copyright",
64+
"osf-footer",
65+
"osf-mode-footer",
66+
"osf-navbar",
67+
"osf-paginator",
68+
"pagination-control",
69+
"search-dropdown",
70+
"sign-up",
71+
"tags-widget"
72+
],
73+
"modules": [
74+
"adapters",
75+
"authenticators",
76+
"authorizers",
77+
"components",
78+
"ember",
79+
"ember-osf",
80+
"ember-preprints",
81+
"helpers",
82+
"mixins",
83+
"models",
84+
"serializers",
85+
"services",
86+
"utils"
87+
],
88+
"allModules": [
89+
{
90+
"displayName": "adapters",
91+
"name": "adapters",
92+
"description": "Base adapter class for all OSF APIv2 endpoints"
93+
},
94+
{
95+
"displayName": "authenticators",
96+
"name": "authenticators",
97+
"description": "Ember-simple-auth compatible authenticator based on session cookie.\n\nIntended to be used with the authorizer of the same name."
98+
},
99+
{
100+
"displayName": "authorizers",
101+
"name": "authorizers",
102+
"description": "Ember-simple-auth compatible authorizer based on session cookie.\n\nIntended to be used with the authenticator of the same name."
103+
},
104+
{
105+
"displayName": "components",
106+
"name": "components",
107+
"description": "Display information about an individual comment, including controls to edit, delete, and report.\nThis component is typically used as part of the `comment-pane` component; see that component for further information.\n\nSample usage:\n```handlebars\n{{comment-detail\n comment=comment\n editComment=attrs.editComment\n deleteComment=attrs.deleteComment\n restoreComment=attrs.restoreComment\n reportComment=attrs.reportComment}}\n```"
108+
},
109+
{
110+
"displayName": "ember",
111+
"name": "ember"
112+
},
113+
{
114+
"displayName": "ember-osf",
115+
"name": "ember-osf",
116+
"description": "Helper functions for asynchronous behavior"
117+
},
118+
{
119+
"displayName": "ember-preprints",
120+
"name": "ember-preprints"
121+
},
122+
{
123+
"displayName": "helpers",
124+
"name": "helpers",
125+
"description": "Generate a unique HTML element ID for this element. Given \"someid\" for component instance 123, returns \"ember123-someid\"\n\nUseful to ensure unique IDs, eg for when component is reused in page."
126+
},
127+
{
128+
"displayName": "mixins",
129+
"name": "mixins",
130+
"description": "Replacement for Ember-simple-auth AuthenticatedRouteMixin. Instead of redirecting to an internal route,\n this mixin redirects to CAS login URL, and brings the user back to the last requested page afterwards\n\nFor OAuth this is done via the state parameter, and for cookies this is done via the service parameter. (TODO: Need a mixin that detects this!)"
131+
},
132+
{
133+
"displayName": "models",
134+
"name": "models",
135+
"description": "Model for OSF APIv2 collections\nFor field and usage information, see:\n* https://api.osf.io/v2/docs/#!/v2/Collection_List_GET"
136+
},
137+
{
138+
"displayName": "serializers",
139+
"name": "serializers",
140+
"description": "Base serializer class for all OSF APIv2 endpoints. Provides custom behaviors for embeds, relationships, and pagination."
141+
},
142+
{
143+
"displayName": "services",
144+
"name": "services",
145+
"description": "Access information about the currently logged in user"
146+
},
147+
{
148+
"displayName": "utils",
149+
"name": "utils",
150+
"description": "Helper functions for asynchronous behavior"
151+
}
152+
],
153+
"elements": []
154+
} };
155+
});

docs/assets/css/external-small.png

491 Bytes
Loading

docs/assets/css/logo.png

6.98 KB
Loading

0 commit comments

Comments
 (0)