mirror of
https://github.com/thelsing/knx.git
synced 2024-12-18 19:08:18 +01:00
update doc generation
This commit is contained in:
parent
1b6763a5cf
commit
49f3a1a501
@ -58,7 +58,7 @@ PROJECT_LOGO =
|
|||||||
# entered, it will be relative to the location where doxygen was started. If
|
# entered, it will be relative to the location where doxygen was started. If
|
||||||
# left blank the current directory will be used.
|
# left blank the current directory will be used.
|
||||||
|
|
||||||
OUTPUT_DIRECTORY = build
|
OUTPUT_DIRECTORY = doxyoutput
|
||||||
|
|
||||||
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
|
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
|
||||||
# directories (in 2 levels) under the output directory of each output format and
|
# directories (in 2 levels) under the output directory of each output format and
|
||||||
@ -1985,7 +1985,7 @@ XML_OUTPUT = xml
|
|||||||
# The default value is: YES.
|
# The default value is: YES.
|
||||||
# This tag requires that the tag GENERATE_XML is set to YES.
|
# This tag requires that the tag GENERATE_XML is set to YES.
|
||||||
|
|
||||||
XML_PROGRAMLISTING = NO
|
XML_PROGRAMLISTING = YES
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Configuration options related to the DOCBOOK output
|
# Configuration options related to the DOCBOOK output
|
||||||
|
@ -21,6 +21,17 @@
|
|||||||
# import sys
|
# import sys
|
||||||
# sys.path.insert(0, os.path.abspath('.'))
|
# sys.path.insert(0, os.path.abspath('.'))
|
||||||
|
|
||||||
|
import subprocess, os
|
||||||
|
|
||||||
|
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
|
||||||
|
|
||||||
|
if read_the_docs_build:
|
||||||
|
subprocess.call('cd ..; wget https://sourceforge.net/projects/plantuml/files/plantuml.jar', shell=True)
|
||||||
|
|
||||||
|
subprocess.call('doxygen', shell=True)
|
||||||
|
subprocess.call('mv ./doxyoutput/html/index.html ./doxyoutput/html/index_doxygen.html', shell=True)
|
||||||
|
html_extra_path = ['./doxyoutput/html']
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
# If your documentation needs a minimal Sphinx version, state it here.
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
@ -31,13 +42,13 @@
|
|||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
# 'sphinx.ext.autodoc',
|
||||||
'sphinx.ext.doctest',
|
# 'sphinx.ext.doctest',
|
||||||
'sphinx.ext.intersphinx',
|
'sphinx.ext.intersphinx',
|
||||||
'sphinx.ext.todo',
|
# 'sphinx.ext.todo',
|
||||||
'sphinx.ext.coverage',
|
# 'sphinx.ext.coverage',
|
||||||
'sphinx.ext.mathjax',
|
# 'sphinx.ext.mathjax',
|
||||||
'sphinx.ext.ifconfig',
|
# 'sphinx.ext.ifconfig',
|
||||||
'breathe',
|
'breathe',
|
||||||
'exhale'
|
'exhale'
|
||||||
]
|
]
|
||||||
@ -59,8 +70,9 @@ exhale_args = {
|
|||||||
"createTreeView": True,
|
"createTreeView": True,
|
||||||
# TIP: if using the sphinx-bootstrap-theme, you need
|
# TIP: if using the sphinx-bootstrap-theme, you need
|
||||||
# "treeViewIsBootstrap": True,
|
# "treeViewIsBootstrap": True,
|
||||||
"exhaleExecutesDoxygen": True,
|
"exhaleExecutesDoxygen": False,
|
||||||
"exhaleDoxygenStdin": "INPUT = ../src ../knx-linux ../examples"
|
#"exhaleDoxygenStdin": "INPUT = ../src ../knx-linux ../examples"
|
||||||
|
#"exhaleUseDoxyfile": True
|
||||||
}
|
}
|
||||||
|
|
||||||
# Tell sphinx what the primary language being documented is.
|
# Tell sphinx what the primary language being documented is.
|
@ -14,6 +14,9 @@ Contents:
|
|||||||
api/library_root
|
api/library_root
|
||||||
|
|
||||||
|
|
||||||
|
`Doxgen documentation <index_doxygen.html>`_ is also available.
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|
2516
doc_old/Doxyfile
Normal file
2516
doc_old/Doxyfile
Normal file
File diff suppressed because it is too large
Load Diff
7
doc_old/example_list.h
Normal file
7
doc_old/example_list.h
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
/**
|
||||||
|
* @example main.cpp
|
||||||
|
* @example knx-demo.ino
|
||||||
|
* @example knx-hdc1008.ino
|
||||||
|
* @example knx-bme680.ino
|
||||||
|
*
|
||||||
|
**/
|
23
doc_old/references.bib
Normal file
23
doc_old/references.bib
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
@manual{knx:3/4/1,
|
||||||
|
organization = "KNX Association",
|
||||||
|
title = "KNX System Specifications Chapter 3/4/1 Application Interface Layer",
|
||||||
|
year = 2013,
|
||||||
|
month = 12,
|
||||||
|
note = "v01.01.02"
|
||||||
|
}
|
||||||
|
|
||||||
|
@manual{knx:3/5/1,
|
||||||
|
organization = "KNX Association",
|
||||||
|
title = "KNX System Specifications Chapter 3/5/1 Resources",
|
||||||
|
year = 2013,
|
||||||
|
month = 12,
|
||||||
|
note = "v01.09.03"
|
||||||
|
}
|
||||||
|
|
||||||
|
@manual{knx:3/7/3,
|
||||||
|
organization = "KNX Association",
|
||||||
|
title = "KNX System Specifications Chapter 3/7/3 Standardized Identifier Tables",
|
||||||
|
year = 2013,
|
||||||
|
month = 12,
|
||||||
|
note = "v01.03.01"
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user