michaelh/zephyr
1
0
Fork 0
Code Releases Activity

CHANGE Doxygen configuration to limit it to the doc folder.

Browse source 
Configures Doxygen to generate its output inside the doc/xml folder. It
also configures Breathe to look for that output in that location.

Patset 2: Changed the project name to Tiny Mountain included aditional
files for Doxygen.

Change-Id: I8514dc7035b196fae365d2f02fe9f6ca54584af0
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Rodrigo Caballero 2015-05-15 11:35:25 -05:00 • committed by Anas Nashif
commit c394b34406
2 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

11
doc/conf.py
View file

@ -105,7 +105,6 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False todo_include_todos = False
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
@ -225,7 +224,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'Tiny Mountain.tex', u'Tiny Mountain Documentation', (master_doc, 'tiny_mountain.tex', u'Tiny Mountain Documentation',
u'many', 'manual'), u'many', 'manual'),
] ]
@ -255,7 +254,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'Tiny Mountain', u'Tiny Mountain Documentation', (master_doc, 'tiny_mountain', u'Tiny Mountain Documentation',
[author], 1) [author], 1)
] ]
@ -269,7 +268,7 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'Tiny Mountain', u'Tiny Mountain Documentation', (master_doc, 'tiny_mountain', u'Tiny Mountain Documentation',
author, 'Tiny Mountain', 'One line description of project.', author, 'Tiny Mountain', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]
@ -286,8 +285,8 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
breathe_projects = { breathe_projects = {
"Tiny Mountain": "../xml", "Tiny Mountain": "xml",
"doc-examples": "xml" "doc-examples": "xml"
} }
breathe_default_project = "Tiny Mountain" breathe_default_project = "Tiny Mountain"

4
doc/doxygen.config
View file

@ -99,7 +99,7 @@ WARN_LOGFILE =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
INPUT = \ INPUT = \
include/microkernel/ \ include/microkernel/ \
kernel/common/ \ kernel/microkernel/ \
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
FILE_PATTERNS = "*.c" "*.h" FILE_PATTERNS = "*.c" "*.h"
RECURSIVE = YES RECURSIVE = YES
@ -137,7 +137,7 @@ IGNORE_PREFIX =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the HTML output # Configuration options related to the HTML output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
GENERATE_HTML = YES GENERATE_HTML = NO
HTML_OUTPUT = html HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html HTML_FILE_EXTENSION = .html
HTML_HEADER = HTML_HEADER =