diff --git a/Makefile b/Makefile index 81122a7c0..fc517737d 100644 --- a/Makefile +++ b/Makefile @@ -14,12 +14,17 @@ help: .PHONY: help Makefile +# Generate the doxygen xml (for Sphinx) and copy the doxygen html to the +# api folder for publishing along with the Sphinx-generated API docs. + +doxy: + $(Q)(cat doxyfile) | doxygen - 2>&1 + $(Q)mkdir -p _build/html/api/doxygen + $(Q)cp -r doxygen/html/* _build/html/api/doxygen -doxy: - $(Q)(cat doxyfile) | doxygen - 2>&1 clean: - $(Q)(rm -fr $(BUILDDIR) doxygen) + $(Q)(rm -fr $(BUILDDIR) doxygen) # Catch-all target: route all unknown targets to Sphinx using the new diff --git a/api/index.rst b/api/index.rst index 03c009fe2..a91c02689 100644 --- a/api/index.rst +++ b/api/index.rst @@ -1,8 +1,18 @@ .. _acrn_apis: -Project ACRN APIs +API Documentation ################# +Welcome to Project ACRN :abbr:`API (Application Programing +Interface)` documentation. + +This section contains the API documentation automatically extracted from +the code. If you are looking for a specific API, enter it on the search +box. The search results display all sections containing information +about that API. + +As a convenience, we've also published the `doxygen-generated API +`_ files as an alternate view of the Project ACRN APIs. .. toctree:: :maxdepth: 1 diff --git a/conf.py b/conf.py index df53baaa3..c21f843c8 100644 --- a/conf.py +++ b/conf.py @@ -45,7 +45,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Project ACRN' +project = u'Project ACRN™' copyright = u'2018, Project ACRN' author = u'Project ARCN developers' @@ -103,7 +103,7 @@ else: # # html_theme_options = {} -html_logo = 'images/ACRNlogo.png' +html_logo = 'images/ACRN_Logo_300w.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/custom-doxygen/DoxygenLayout.xml b/custom-doxygen/DoxygenLayout.xml new file mode 100644 index 000000000..ac353bf86 --- /dev/null +++ b/custom-doxygen/DoxygenLayout.xml @@ -0,0 +1,194 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/custom-doxygen/customdoxygen.css b/custom-doxygen/customdoxygen.css index c6b0079b0..cca5056c3 100644 --- a/custom-doxygen/customdoxygen.css +++ b/custom-doxygen/customdoxygen.css @@ -15,3 +15,20 @@ pre.fragment { white-space: pre; background-color: #D8D8D8; } + +#projectlogo +{ + vertical-align: middle; +} + +#projectname +{ + font: 200% Tahoma, Arial,sans-serif; + color: #006469; + +} + +#projectbrief +{ + color: #006469; +} diff --git a/custom-doxygen/header.html b/custom-doxygen/header.html index 13af98a80..b9c554334 100644 --- a/custom-doxygen/header.html +++ b/custom-doxygen/header.html @@ -26,7 +26,7 @@ $extrastylesheet - Logo + Logo diff --git a/custom-doxygen/mainpage.md b/custom-doxygen/mainpage.md index acc1f0b7a..773bad693 100644 --- a/custom-doxygen/mainpage.md +++ b/custom-doxygen/mainpage.md @@ -1,8 +1,9 @@ -# CWP Hypervisor Documentation {#index} +# API Documentation {#index} -Clearwater Pass is a flexible and lighweight hypervisor, built with -real-time, functional safety, and security in mind. It streamlines +Project ACRN is a flexible and lighweight hypervisor, built with +real-time and safety-criticality in mind. It streamlines embedded development through a scalable open source reference platform that addresses embedded developers' needs. - +You can get an alternate view this API material in the [Project ACRN +documentation](../). diff --git a/doxyfile b/doxyfile index a3a4315b2..1af23f45d 100644 --- a/doxyfile +++ b/doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "ProjectACRN" +PROJECT_NAME = "Project ACRN™" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -44,14 +44,14 @@ PROJECT_NUMBER = # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "Open Source Automotive Hypervisor for Intel® Architecture" +PROJECT_BRIEF = "A flexible, light-weight, open source reference hypervisor for IoT devices." # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = "images/ACRN_Logo_56h.png" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -703,7 +703,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = custom-doxygen/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1120,7 +1120,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = +HTML_HEADER = custom-doxygen/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard diff --git a/images/ACRN_Logo_300w.png b/images/ACRN_Logo_300w.png new file mode 100644 index 000000000..c26a69b6d Binary files /dev/null and b/images/ACRN_Logo_300w.png differ diff --git a/images/ACRN_Logo_56h.png b/images/ACRN_Logo_56h.png new file mode 100644 index 000000000..df74c0efc Binary files /dev/null and b/images/ACRN_Logo_56h.png differ