michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: rename doxygen configuration file and build from doc/

Browse source 
Rename file to zephyr.doxyfile to allow integration in eclipse and make
it build locally in the doc/ directory without have to change to ../
first.

Change-Id: Ib2c4c26f385b050ea3d0e814ebfc3509f31e5e12
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2017-02-05 09:24:50 -05:00 • committed by Anas Nashif
commit 1fdfc5dc2b
3 changed files with 17 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/Makefile
View file

@ -26,7 +26,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
doxy-code: doxy-code:
$(Q)cd .. && doxygen doc/doxygen.config $(Q)doxygen zephyr.doxyfile
doxy: doxy-code doxy: doxy-code

4
doc/conf.py
View file

@ -318,8 +318,8 @@ texinfo_documents = [
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
breathe_projects = { breathe_projects = {
"Zephyr": "xml", "Zephyr": "doxygen/xml",
"doc-examples": "xml" "doc-examples": "doxygen/xml"
} }
breathe_default_project = "Zephyr" breathe_default_project = "Zephyr"

26
doc/doxygen.config → doc/zephyr.doxyfile
View file

@ -8,7 +8,7 @@ PROJECT_NAME = "Zephyr Project"
PROJECT_NUMBER = PROJECT_NUMBER =
PROJECT_BRIEF = PROJECT_BRIEF =
PROJECT_LOGO = PROJECT_LOGO =
OUTPUT_DIRECTORY = doc/ OUTPUT_DIRECTORY = doxygen/
CREATE_SUBDIRS = YES CREATE_SUBDIRS = YES
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES BRIEF_MEMBER_DESC = YES
@ -98,17 +98,19 @@ WARN_LOGFILE =
# Configuration options related to the input files # Configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
INPUT = \ INPUT = \
include/ \ ../include/ \
include/misc/ \ ../include/misc/ \
include/arch/x86/ \ ../include/arch/x86/ \
include/arch/arc/ include/arch/arc/v2 \ ../include/arch/arc/ \
include/arch/arm/ include/arch/arm/cortex_m \ ../include/arch/arc/v2 \
include/arch/nios2/ \ ../include/arch/arm/ \
lib/libc/minimal/include/ \ ../include/arch/arm/cortex_m \
ext/lib/crypto/tinycrypt/include/ \ ../include/arch/nios2/ \
include/net/zoap.h \ ../lib/libc/minimal/include/ \
include/net/dns_client.h \ ../ext/lib/crypto/tinycrypt/include/ \
tests/ztest/include/ ../include/net/zoap.h \
../include/net/dns_client.h \
../tests/ztest/include/
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
FILE_PATTERNS = "*.c" "*.h" "*.S" FILE_PATTERNS = "*.c" "*.h" "*.S"
RECURSIVE = YES RECURSIVE = YES