Skip to content

Commit 39a37b4

Browse files
umar456umar456
committed
Initial documentation for ArrayFire 3.0
Doxygen documentation for ArrayFire. Similar to ArrayFire 2.0. Slightly modified for the simplified C API. Moved assets to a seperate submodule.
1 parent 6e78350 commit 39a37b4

17 files changed

+4268
-0
lines changed

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
[submodule "test/data"]
22
path = test/data
33
url = https://github.com/arrayfire/arrayfire_data
4+
[submodule "docs/assets"]
5+
path = docs/assets
6+
url = ssh://git@github.com/arrayfire/assets

‎CMakeLists.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ OPTION(BUILD_CPU "Build ArrayFire with a CPU backend" ON)
1010
OPTION(BUILD_CUDA "Build ArrayFire with a CUDA backend" OFF)
1111
OPTION(BUILD_OPENCL "Build ArrayFire with a OpenCL backend" OFF)
1212

13+
OPTION(BUILD_DOCS "Create ArrayFire Documentation" OFF)
14+
1315
SET(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules")
1416

1517
FIND_PACKAGE(FreeImage)
@@ -77,6 +79,10 @@ IF(${BUILD_OPENCL})
7779
ADD_SUBDIRECTORY(src/backend/opencl)
7880
ENDIF()
7981

82+
IF(${BUILD_DOCS})
83+
ADD_SUBDIRECTORY(docs)
84+
ENDIF()
85+
8086
ADD_EXECUTABLE(bin2cpp ${CMAKE_MODULE_PATH}/bin2cpp.cpp)
8187

8288
IF(${BUILD_TEST})

‎docs/CMakeLists.txt‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
FIND_PACKAGE(Doxygen)
2+
3+
IF(${DOXYGEN_FOUND})
4+
SET(AF_DOCS_CONFIG "${CMAKE_CURRENT_SOURCE_DIR}/doxygen.mk")
5+
SET(AF_DOCS_CONFIG_OUT "${CMAKE_CURRENT_BINARY_DIR}/doxygen.mk.out")
6+
7+
SET(AF_DOCS_LAYOUT "${CMAKE_CURRENT_SOURCE_DIR}/layout.xml")
8+
SET(AF_DOCS_LAYOUT_OUT "${CMAKE_CURRENT_BINARY_DIR}/layout.xml.out")
9+
10+
SET(DOCS_DIR ${CMAKE_CURRENT_SOURCE_DIR})
11+
SET(INCLUDE_DIR "${CMAKE_SOURCE_DIR}/include")
12+
CONFIGURE_FILE(${AF_DOCS_CONFIG} ${AF_DOCS_CONFIG_OUT})
13+
CONFIGURE_FILE(${AF_DOCS_LAYOUT} ${AF_DOCS_LAYOUT_OUT})
14+
15+
ADD_CUSTOM_TARGET(docs
16+
COMMAND ${DOXYGEN_EXECUTABLE} ${AF_DOCS_CONFIG_OUT}
17+
COMMAND cmake -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/gfx ${CMAKE_CURRENT_BINARY_DIR}
18+
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
19+
COMMENT "Generating Documentation"
20+
VERBATIM)
21+
INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION share/doc)
22+
ENDIF()

‎docs/Prototype.ttf‎

28.9 KB
Binary file not shown.

‎docs/arrayfire.css‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
/* The standard CSS for doxygen 1.8.5 */
2+
3+
body, table, div, p, dl
4+
{
5+
font : 400 12px/22px Lucida Grande, Verdana, Geneva, Arial, sans-serif;
6+
}
7+
8+
/* @group Heading Levels */
9+
/* Increase the size of the page title */
10+
.title
11+
{
12+
font-size : 250%;
13+
}
14+
15+
/* Remove space above line items */
16+
ul
17+
{
18+
margin-top : 0em;
19+
}
20+
21+
/* Slightly pad subsections */
22+
h2
23+
{
24+
padding-left : 20px;
25+
margin-bottom : 0px;
26+
}
27+
28+
/* Margins on the left of the code */
29+
div.line
30+
{
31+
margin-left : 15px;
32+
}
33+
34+
a.code, a.code:visited, a.line, a.line:visited
35+
{
36+
color : #4665A2;
37+
}
38+
39+
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited
40+
{
41+
color : #4665A2;
42+
}
43+
44+
@font-face
45+
{
46+
font-family : prototype;
47+
src : url('Prototype.ttf');
48+
}
49+
50+
/*image and image groups*/
51+
div.image_group
52+
{
53+
text-align : center;
54+
}
55+
56+
div.image_group > div
57+
{
58+
display : inline-block;
59+
}
60+
61+
div.scaled > img
62+
{
63+
max-width : 250px;
64+
}
65+
66+
div.scaled > img:hover
67+
{
68+
-ms-transform : scale(2, 2);
69+
-webkit-transform : scale(2, 2);
70+
-moz-transform : scale(2, 2);
71+
transform : scale(2, 2);
72+
}
73+
74+
/*ArrayFire Feature Support Settings*/
75+
div.support
76+
{
77+
text-align : right;
78+
}
79+
80+
div.support *
81+
{
82+
display : inline-block;
83+
max-width : 50px;
84+
}
85+
86+
#under_logo
87+
{
88+
font-family : prototype;
89+
font-size : 2em;
90+
max-width : 25px;
91+
color : #000000;
92+
}
93+
94+
#projectbrief
95+
{
96+
font-family : prototype;
97+
color : #555555
98+
}
99+
100+
#projectlogo
101+
{
102+
width : 300px;
103+
text-align : left;
104+
}
105+
106+
#projectnumber
107+
{
108+
max-width : 25px;
109+
}
110+
111+
#projectname
112+
{
113+
font-family : prototype;
114+
font-size : 3em;
115+
max-width : 25px;
116+
color : #555555
117+
}
118+
119+
#gsearch
120+
{
121+
width : 150px;
122+
}
123+
124+
.tablist span
125+
{
126+
font-weight : normal;
127+
font-family : "Raleway","Helvetica Neue",Helvetica,sans-serif;
128+
color : #FFFFFF;
129+
text-shadow : none;
130+
}
131+
132+
#nav-tree
133+
{
134+
background-color : #F7F7F7;
135+
}
136+
137+
div.toc
138+
{
139+
background-color : #F7F7F7;
140+
border : 1px solid #DFDFDF;
141+
}
142+
143+
#nav-tree
144+
{
145+
background-color : #F7F7F7;
146+
}
147+
148+
div.toc
149+
{
150+
background-color : #F7F7F7;
151+
border : 1px solid #DFDFDF;
152+
}
153+
154+
.tablist a
155+
{
156+
background-image:url('tab_b.png');
157+
}
158+
159+
div.header
160+
{
161+
background-image : none;
162+
background-color : #F7F7F7;
163+
border-bottom : 1px solid #DFDFDF;
164+
}
165+
166+
#nav-tree
167+
{
168+
background-image : none;
169+
}
170+
171+
.ui-resizable-e
172+
{
173+
background : url("ftv2splitbar1.png") repeat scroll right center transparent;
174+
}
175+
176+
div.fragment
177+
{
178+
background-color : #F7F7F7;
179+
border : 1px solid #DFDFDF;
180+
}
181+
182+
/* @end */

‎docs/assets‎

Submodule assets added at 49c6afc

0 commit comments

Comments
 (0)