michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Changes conf.py and fine tunes doxygen.config for index & auto-generated files.

Browse source 
Improves previous patch that enabled doxygen GUI for Reference.
Navigate to forto-collab/docs/ html/index.html to view. Not
linked to main docs in this patch. Index changes to show a
collapsed view as default.

Change-Id: I4d0c23699f645c5c20ca3ad50c988a5729afa24f
Signed-off-by: Carol Lee <carol.lee@windriver.com>
This commit is contained in:
Carol Lee 2015-08-07 13:22:27 -04:00 • committed by Anas Nashif
commit 1aa7733298
2 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/conf.py
View file

@ -103,7 +103,7 @@ pygments_style = 'sphinx'
#keep_warnings = False #keep_warnings = False
# 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 = True todo_include_todos = False
rst_epilog = """ rst_epilog = """
.. include:: /substitutions.rst .. include:: /substitutions.rst
@ -156,7 +156,7 @@ html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
#html_use_smartypants = True #html_use_smartypants =
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
#html_sidebars = {} #html_sidebars = {}
@ -166,22 +166,22 @@ html_last_updated_fmt = '%b %d, %Y'
#html_additional_pages = {} #html_additional_pages = {}
# If false, no module index is generated. # If false, no module index is generated.
#html_domain_indices = True html_domain_indices = False
# If false, no index is generated. # If false, no index is generated.
#html_use_index = True html_use_index = True
# If true, the index is split into individual pages for each letter. # If true, the index is split into individual pages for each letter.
#html_split_index = False html_split_index = True
# If true, links to the reST sources are added to the pages. # If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True #html_show_sourcelink =
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True #html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will # If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the # contain a <link> tag referring to it. The value of this option must be the

5
doc/doxygen.config
View file

@ -13,8 +13,8 @@ CREATE_SUBDIRS = YES
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = NO ABBREVIATE_BRIEF = YES
ALWAYS_DETAILED_SEC = ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = YES INLINE_INHERITED_MEMB = YES
FULL_PATH_NAMES = YES FULL_PATH_NAMES = YES
STRIP_FROM_PATH = STRIP_FROM_PATH =
@ -100,7 +100,6 @@ WARN_LOGFILE =
INPUT = \ INPUT = \
include/\ include/\
lib/libc/minimal/include/\ lib/libc/minimal/include/\
misc/ \
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
FILE_PATTERNS = "*.c" "*.h" "*.S" FILE_PATTERNS = "*.c" "*.h" "*.S"
RECURSIVE = YES RECURSIVE = YES