michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: flatten doxygen-generated HTML structure

Browse source 
The current doxygen configuration settings create 4096 folders to hold
the generated HTML output (with names such as d3/ddb/).  This makes it
difficult to know what an URL would be for a particular module's
(defgroup's) documentation.  By not creating these subdirectories,
module documentation file names become quite predictable:

     group__<group name>.html

(e.g., group__sensor__interface.html) allowing us to create
links from the Sphinx-generated documentation into the doxygen-generated
HTML content (this part is under investigation).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-05-08 13:51:23 -07:00 • committed by Anas Nashif
commit 18859171a3
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/zephyr.doxyfile
View file

@ -68,7 +68,7 @@ OUTPUT_DIRECTORY = doxygen/
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = YES
CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this