michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: fix doxygen INPUT path; brand html output

Browse source 
Clean up the INPUT paths for doxygen scanning:

- directory scans include sub-directories so no need
  to include them explicitly
- remove excluded (legacy) includes that no longer exist

Sync directory changes in the CMakeLists.txt (as noted in the comments)

Add content to the home page of the doxygen-generated HTML, and add a
Zephyr branding theme.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>

Fixes: #6773
This commit is contained in:
David B. Kinder 2019-06-25 15:54:19 -07:00 • committed by Anas Nashif
commit b30b52abd5
7 changed files with 157 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

36
doc/custom-doxygen/customdoxygen.css Normal file
View file

@ -0,0 +1,36 @@
/* Custom CSS for Doxygen-generated HTML
* Copyright (c) 2015 Intel Corporation
* SPDX-License-Identifier: Apache-2.0
*/
code {
font-family: Monaco,Menlo,Consolas,"Courier New",monospace;
background-color: #D8D8D8;
padding: 0 0.25em 0 0.25em;
}
pre.fragment {
display: block;
font-family: Monaco,Menlo,Consolas,"Courier New",monospace;
padding: 1rem;
word-break: break-all;
word-wrap: break-word;
white-space: pre;
background-color: #D8D8D8;
}
#projectlogo
{
vertical-align: middle;
}
#projectname
{
font: 200% Tahoma, Arial,sans-serif;
color: #3D578C;
}
#projectbrief
{
color: #3D578C;
}

21
doc/custom-doxygen/footer.html Normal file
View file

@ -0,0 +1,21 @@
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
<li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> $doxygenversion
</small></address>
<!--END !GENERATE_TREEVIEW-->
</body>
</html>

57
doc/custom-doxygen/header.html Normal file
View file

@ -0,0 +1,57 @@
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
$mathjax
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!--BEGIN TITLEAREA-->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<!--BEGIN PROJECT_LOGO-->
<td id="projectlogo"><a href="https://docs.zephyrproject.org/latest/"
target="_blank"><img alt="Logo" src="$relpath^$projectlogo"/></a></td>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td id="projectalign" style="padding-left: 1em;">
<div id="projectname">$projectname
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
</div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
</td>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<td style="padding-left: 0.5em;">
<div id="projectbrief">$projectbrief</div>
</td>
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<td>$searchbox</td>
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
</tr>
</tbody>
</table>
</div>
<!--END TITLEAREA-->
<!-- end header part -->

29
doc/custom-doxygen/mainpage.md Normal file
View file

@ -0,0 +1,29 @@
# API Documentation {#index}
## Introduction
The Zephyr OS is a small-footprint kernel designed for use on
resource-constrained and embedded systems: from simple embedded
environmental sensors and LED wearables to sophisticated embedded
controllers, smart watches, and IoT wireless applications.
See the [zephyrproject.org](https://zephyrproject.org) site for more
information about the project and becoming a member, and this [summary
of Zephyr resources](https://docs.zephyrproject.org/latest/introduction/index.html#resources)
to help you find your way around the project.
## Supported Boards
The Zephyr kernel supports multiple architectures, including ARM
Cortex-M, Intel x86, ARC, NIOS II, Tensilica Xtensa, and RISC-V 32. For
details, see the [latest supported boards
documentation](https://docs.zephyrproject.org/latest/boards/index.html).
## Licensing
Zephyr is permissively licensed using the Apache 2.0 license (as found
in the [project's GitHub LICENSE
file](https://github.com/zephyrproject-rtos/zephyr/blob/master/LICENSE).
There are some imported or reused components of the Zephyr project that
use other licensing, as described in [Licensing of Zephyr Project
components](https://docs.zephyrproject.org/latest/LICENSING.html#zephyr-licensing).