Skip to content

Commit dce6161

Browse files
dbkinderlijinxia
dbkinder
authored and
lijinxia
committed
doc: organizational and look improvements
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1 parent 0520475 commit dce6161

File tree

10 files changed

+243
-16
lines changed

10 files changed

+243
-16
lines changed

‎doc/Makefile

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,17 @@ help:
1414

1515
.PHONY: help Makefile
1616

17+
# Generate the doxygen xml (for Sphinx) and copy the doxygen html to the
18+
# api folder for publishing along with the Sphinx-generated API docs.
19+
20+
doxy:
21+
$(Q)(cat doxyfile) | doxygen - 2>&1
22+
$(Q)mkdir -p _build/html/api/doxygen
23+
$(Q)cp -r doxygen/html/* _build/html/api/doxygen
1724

18-
doxy:
19-
$(Q)(cat doxyfile) | doxygen - 2>&1
2025

2126
clean:
22-
$(Q)(rm -fr $(BUILDDIR) doxygen)
27+
$(Q)(rm -fr $(BUILDDIR) doxygen)
2328

2429

2530
# Catch-all target: route all unknown targets to Sphinx using the new

‎doc/api/index.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
.. _acrn_apis:
22

3-
Project ACRN APIs
3+
API Documentation
44
#################
55

6+
Welcome to Project ACRN :abbr:`API (Application Programing
7+
Interface)` documentation.
8+
9+
This section contains the API documentation automatically extracted from
10+
the code. If you are looking for a specific API, enter it on the search
11+
box. The search results display all sections containing information
12+
about that API.
13+
14+
As a convenience, we've also published the `doxygen-generated API
15+
<doxygen>`_ files as an alternate view of the Project ACRN APIs.
616

717
.. toctree::
818
:maxdepth: 1

‎doc/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
master_doc = 'index'
4646

4747
# General information about the project.
48-
project = u'Project ACRN'
48+
project = u'Project ACRN™'
4949
copyright = u'2018, Project ACRN'
5050
author = u'Project ARCN developers'
5151

@@ -103,7 +103,7 @@
103103
#
104104
# html_theme_options = {}
105105

106-
html_logo = 'images/ACRNlogo.png'
106+
html_logo = 'images/ACRN_Logo_300w.png'
107107

108108
# Add any paths that contain custom static files (such as style sheets) here,
109109
# relative to this directory. They are copied after the builtin static files,

‎doc/custom-doxygen/DoxygenLayout.xml

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
<doxygenlayout version="1.0">
2+
<!-- Generated by doxygen 1.8.13 -->
3+
<!-- Navigation index tabs for HTML output -->
4+
<navindex>
5+
<tab type="mainpage" visible="yes" title=""/>
6+
<tab type="pages" visible="yes" title="" intro=""/>
7+
<tab type="modules" visible="yes" title="" intro=""/>
8+
<tab type="namespaces" visible="yes" title="">
9+
<tab type="namespacelist" visible="yes" title="" intro=""/>
10+
<tab type="namespacemembers" visible="yes" title="" intro=""/>
11+
</tab>
12+
<tab type="classes" visible="yes" title="">
13+
<tab type="classlist" visible="yes" title="" intro=""/>
14+
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
15+
<tab type="hierarchy" visible="yes" title="" intro=""/>
16+
<tab type="classmembers" visible="yes" title="" intro=""/>
17+
</tab>
18+
<tab type="files" visible="yes" title="">
19+
<tab type="filelist" visible="yes" title="" intro=""/>
20+
<tab type="globals" visible="yes" title="" intro=""/>
21+
</tab>
22+
<tab type="examples" visible="yes" title="" intro=""/>
23+
</navindex>
24+
25+
<!-- Layout definition for a class page -->
26+
<class>
27+
<briefdescription visible="yes"/>
28+
<includes visible="$SHOW_INCLUDE_FILES"/>
29+
<inheritancegraph visible="$CLASS_GRAPH"/>
30+
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
31+
<memberdecl>
32+
<nestedclasses visible="yes" title=""/>
33+
<publictypes title=""/>
34+
<services title=""/>
35+
<interfaces title=""/>
36+
<publicslots title=""/>
37+
<signals title=""/>
38+
<publicmethods title=""/>
39+
<publicstaticmethods title=""/>
40+
<publicattributes title=""/>
41+
<publicstaticattributes title=""/>
42+
<protectedtypes title=""/>
43+
<protectedslots title=""/>
44+
<protectedmethods title=""/>
45+
<protectedstaticmethods title=""/>
46+
<protectedattributes title=""/>
47+
<protectedstaticattributes title=""/>
48+
<packagetypes title=""/>
49+
<packagemethods title=""/>
50+
<packagestaticmethods title=""/>
51+
<packageattributes title=""/>
52+
<packagestaticattributes title=""/>
53+
<properties title=""/>
54+
<events title=""/>
55+
<privatetypes title=""/>
56+
<privateslots title=""/>
57+
<privatemethods title=""/>
58+
<privatestaticmethods title=""/>
59+
<privateattributes title=""/>
60+
<privatestaticattributes title=""/>
61+
<friends title=""/>
62+
<related title="" subtitle=""/>
63+
<membergroups visible="yes"/>
64+
</memberdecl>
65+
<detaileddescription title=""/>
66+
<memberdef>
67+
<inlineclasses title=""/>
68+
<typedefs title=""/>
69+
<enums title=""/>
70+
<services title=""/>
71+
<interfaces title=""/>
72+
<constructors title=""/>
73+
<functions title=""/>
74+
<related title=""/>
75+
<variables title=""/>
76+
<properties title=""/>
77+
<events title=""/>
78+
</memberdef>
79+
<allmemberslink visible="yes"/>
80+
<usedfiles visible="$SHOW_USED_FILES"/>
81+
<authorsection visible="yes"/>
82+
</class>
83+
84+
<!-- Layout definition for a namespace page -->
85+
<namespace>
86+
<briefdescription visible="yes"/>
87+
<memberdecl>
88+
<nestednamespaces visible="yes" title=""/>
89+
<constantgroups visible="yes" title=""/>
90+
<classes visible="yes" title=""/>
91+
<typedefs title=""/>
92+
<enums title=""/>
93+
<functions title=""/>
94+
<variables title=""/>
95+
<membergroups visible="yes"/>
96+
</memberdecl>
97+
<detaileddescription title=""/>
98+
<memberdef>
99+
<inlineclasses title=""/>
100+
<typedefs title=""/>
101+
<enums title=""/>
102+
<functions title=""/>
103+
<variables title=""/>
104+
</memberdef>
105+
<authorsection visible="yes"/>
106+
</namespace>
107+
108+
<!-- Layout definition for a file page -->
109+
<file>
110+
<briefdescription visible="yes"/>
111+
<includes visible="$SHOW_INCLUDE_FILES"/>
112+
<includegraph visible="$INCLUDE_GRAPH"/>
113+
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
114+
<sourcelink visible="yes"/>
115+
<memberdecl>
116+
<classes visible="yes" title=""/>
117+
<namespaces visible="yes" title=""/>
118+
<constantgroups visible="yes" title=""/>
119+
<defines title=""/>
120+
<typedefs title=""/>
121+
<enums title=""/>
122+
<functions title=""/>
123+
<variables title=""/>
124+
<membergroups visible="yes"/>
125+
</memberdecl>
126+
<detaileddescription title=""/>
127+
<memberdef>
128+
<inlineclasses title=""/>
129+
<defines title=""/>
130+
<typedefs title=""/>
131+
<enums title=""/>
132+
<functions title=""/>
133+
<variables title=""/>
134+
</memberdef>
135+
<authorsection/>
136+
</file>
137+
138+
<!-- Layout definition for a group page -->
139+
<group>
140+
<briefdescription visible="yes"/>
141+
<groupgraph visible="$GROUP_GRAPHS"/>
142+
<memberdecl>
143+
<nestedgroups visible="yes" title=""/>
144+
<dirs visible="yes" title=""/>
145+
<files visible="yes" title=""/>
146+
<namespaces visible="yes" title=""/>
147+
<classes visible="yes" title=""/>
148+
<defines title=""/>
149+
<typedefs title=""/>
150+
<enums title=""/>
151+
<enumvalues title=""/>
152+
<functions title=""/>
153+
<variables title=""/>
154+
<signals title=""/>
155+
<publicslots title=""/>
156+
<protectedslots title=""/>
157+
<privateslots title=""/>
158+
<events title=""/>
159+
<properties title=""/>
160+
<friends title=""/>
161+
<membergroups visible="yes"/>
162+
</memberdecl>
163+
<detaileddescription title=""/>
164+
<memberdef>
165+
<pagedocs/>
166+
<inlineclasses title=""/>
167+
<defines title=""/>
168+
<typedefs title=""/>
169+
<enums title=""/>
170+
<enumvalues title=""/>
171+
<functions title=""/>
172+
<variables title=""/>
173+
<signals title=""/>
174+
<publicslots title=""/>
175+
<protectedslots title=""/>
176+
<privateslots title=""/>
177+
<events title=""/>
178+
<properties title=""/>
179+
<friends title=""/>
180+
</memberdef>
181+
<authorsection visible="yes"/>
182+
</group>
183+
184+
<!-- Layout definition for a directory page -->
185+
<directory>
186+
<briefdescription visible="yes"/>
187+
<directorygraph visible="yes"/>
188+
<memberdecl>
189+
<dirs visible="yes"/>
190+
<files visible="yes"/>
191+
</memberdecl>
192+
<detaileddescription title=""/>
193+
</directory>
194+
</doxygenlayout>

‎doc/custom-doxygen/customdoxygen.css

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,20 @@ pre.fragment {
1515
white-space: pre;
1616
background-color: #D8D8D8;
1717
}
18+
19+
#projectlogo
20+
{
21+
vertical-align: middle;
22+
}
23+
24+
#projectname
25+
{
26+
font: 200% Tahoma, Arial,sans-serif;
27+
color: #006469;
28+
29+
}
30+
31+
#projectbrief
32+
{
33+
color: #006469;
34+
}

‎doc/custom-doxygen/header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
<tbody>
2727
<tr style="height: 56px;">
2828
<!--BEGIN PROJECT_LOGO-->
29-
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
29+
<td id="projectlogo"><a href="/"><img alt="Logo" src="$relpath^$projectlogo"/></a></td>
3030
<!--END PROJECT_LOGO-->
3131
<!--BEGIN PROJECT_NAME-->
3232
<td id="projectalign" style="padding-left: 0.5em;">

‎doc/custom-doxygen/mainpage.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# CWP Hypervisor Documentation {#index}
1+
# API Documentation {#index}
22

3-
Clearwater Pass is a flexible and lighweight hypervisor, built with
4-
real-time, functional safety, and security in mind. It streamlines
3+
Project ACRN is a flexible and lighweight hypervisor, built with
4+
real-time and safety-criticality in mind. It streamlines
55
embedded development through a scalable open source reference platform
66
that addresses embedded developers' needs.
77

8-
8+
You can get an alternate view this API material in the [Project ACRN
9+
documentation](../).

‎doc/doxyfile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "ProjectACRN"
35+
PROJECT_NAME = "Project ACRN™"
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version
@@ -44,14 +44,14 @@ PROJECT_NUMBER =
4444
# for a project that appears at the top of each page and should give viewer a
4545
# quick idea about the purpose of the project. Keep the description short.
4646

47-
PROJECT_BRIEF = "Open Source Automotive Hypervisor for Intel® Architecture"
47+
PROJECT_BRIEF = "A flexible, light-weight, open source reference hypervisor for IoT devices."
4848

4949
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
5050
# in the documentation. The maximum height of the logo should not exceed 55
5151
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
5252
# the logo to the output directory.
5353

54-
PROJECT_LOGO =
54+
PROJECT_LOGO = "images/ACRN_Logo_56h.png"
5555

5656
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
5757
# into which the generated documentation will be written. If a relative path is
@@ -703,7 +703,7 @@ FILE_VERSION_FILTER =
703703
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
704704
# tag is left empty.
705705

706-
LAYOUT_FILE =
706+
LAYOUT_FILE = custom-doxygen/DoxygenLayout.xml
707707

708708
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
709709
# the reference definitions. This must be a list of .bib files. The .bib
@@ -1120,7 +1120,7 @@ HTML_FILE_EXTENSION = .html
11201120
# of the possible markers and block names see the documentation.
11211121
# This tag requires that the tag GENERATE_HTML is set to YES.
11221122

1123-
HTML_HEADER =
1123+
HTML_HEADER = custom-doxygen/header.html
11241124

11251125
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
11261126
# generated HTML page. If the tag is left blank doxygen will generate a standard

‎doc/images/ACRN_Logo_300w.png

23.2 KB
Loading

‎doc/images/ACRN_Logo_56h.png

12.7 KB
Loading

0 commit comments

Comments
 (0)