You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jr...@apache.org on 2016/01/29 00:47:43 UTC
svn commit: r1727460 - in /qpid/site: Makefile python/generate.py
scripts/gen-proton-release-api-doc
Author: jross
Date: Thu Jan 28 23:47:43 2016
New Revision: 1727460
URL: http://svn.apache.org/viewvc?rev=1727460&view=rev
Log:
QPID-6970: Support use of existing doxygen conf with overrides; rename API reference docs; remove the need to source config.sh
Modified:
qpid/site/Makefile
qpid/site/python/generate.py
qpid/site/scripts/gen-proton-release-api-doc
Modified: qpid/site/Makefile
URL: http://svn.apache.org/viewvc/qpid/site/Makefile?rev=1727460&r1=1727459&r2=1727460&view=diff
==============================================================================
--- qpid/site/Makefile (original)
+++ qpid/site/Makefile Thu Jan 28 23:47:43 2016
@@ -1,8 +1,6 @@
.PHONY: default help render devel-render check-links check-output-files clean devel-publish
-ifndef TRANSOM_HOME
- $(error "Run 'source config.sh' first")
-endif
+export PYTHONPATH = python
OUTPUT_DIR := output
SITE_URL := file://$(shell readlink -f ${OUTPUT_DIR})
Modified: qpid/site/python/generate.py
URL: http://svn.apache.org/viewvc/qpid/site/python/generate.py?rev=1727460&r1=1727459&r2=1727460&view=diff
==============================================================================
--- qpid/site/python/generate.py (original)
+++ qpid/site/python/generate.py Thu Jan 28 23:47:43 2016
@@ -162,7 +162,7 @@ def export_release_from_git(module, rele
_doxygen_conf_template = u"""
DISABLE_INDEX = yes
-EXTRACT_ALL = yes
+EXTRACT_ALL = no
EXAMPLE_PATH = {example_paths}
GENERATE_HTML = yes
GENERATE_LATEX = no
@@ -178,15 +178,22 @@ HTML_OUTPUT = {output_dir}
"""
def gen_doxygen(release, title, input_paths, strip_paths, output_dir,
- example_paths=[]):
+ example_paths=[], config_file=None):
input_paths = " ".join(input_paths)
strip_paths = " ".join(strip_paths)
example_paths = " ".join(example_paths)
make_dir(output_dir)
- conf = _doxygen_conf_template.format(**locals())
- path = write_temp("conf", conf)
+ source_conf = ""
+
+ if config_file is not None:
+ source_conf = read(config_file)
+
+ path = make_temp("conf")
+
+ write(path, source_conf)
+ append(path, local_conf)
call("doxygen {}", path)
@@ -306,7 +313,7 @@ _license_header_regexes = {
"csharp": re.compile(r"/\*.*?\*/", re.DOTALL),
"java": re.compile(r"/\*.*?\*/", re.DOTALL),
"php": re.compile(r"/\*.*?\*/", re.DOTALL),
- }
+}
def strip_license_header(string, lang):
if lang in _license_header_regexes:
Modified: qpid/site/scripts/gen-proton-release-api-doc
URL: http://svn.apache.org/viewvc/qpid/site/scripts/gen-proton-release-api-doc?rev=1727460&r1=1727459&r2=1727460&view=diff
==============================================================================
--- qpid/site/scripts/gen-proton-release-api-doc (original)
+++ qpid/site/scripts/gen-proton-release-api-doc Thu Jan 28 23:47:43 2016
@@ -42,7 +42,7 @@ def gen_c_api_doc(release, source_dir, c
output_dir = join(component_dir, "c", "api")
gen_doxygen(release=release,
- title="C AMQP Protocol Engine API",
+ title="Qpid Proton C API",
input_paths=(input_path,),
strip_paths=(include_dir,),
output_dir=output_dir)
@@ -52,16 +52,18 @@ def gen_cpp_api_doc(release, source_dir,
include_dir = join(base_dir, "include")
input_path = join(include_dir, "proton")
output_dir = join(component_dir, "cpp", "api")
+ config_file = join(base_dir, "docs", "user.doxygen.in")
gen_doxygen(release=release,
- title="C++ AMQP Protocol Engine API",
+ title="Qpid Proton C++ API",
input_paths=(input_path,
join(base_dir, "docs"),
join(source_dir, "examples", "cpp", "README.hpp")
),
- strip_paths=(include_dir),
+ strip_paths=(include_dir,),
output_dir=output_dir,
- example_paths=(join(source_dir, "examples", "cpp"),))
+ example_paths=(join(source_dir, "examples", "cpp"),),
+ config_file=config_file)
def gen_java_api_doc(release, source_dir, component_dir):
input_path = join(source_dir, "proton-j", "src", "main", "java")
@@ -69,7 +71,7 @@ def gen_java_api_doc(release, source_dir
output_dir = join(component_dir, "java", "api")
gen_javadoc(release=release,
- title="Java AMQP Protocol Engine API",
+ title="Qpid Proton Java API",
input_paths=(input_path,),
input_namespaces=(input_namespace,),
output_dir=output_dir)
@@ -80,7 +82,7 @@ def gen_python_api_doc(release, source_d
output_dir = join(component_dir, "python", "api")
gen_epydoc(release=release,
- title="Python AMQP Protocol Engine API",
+ title="Qpid Proton Python API",
input_paths=(input_path,),
input_namespaces=(input_namespace,),
output_dir=output_dir)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org