From 8ce8429f8694ee93c5e5cb2ddddc3de0f0a84667 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Tue, 24 May 2016 12:51:52 +0800 Subject: [PATCH 1/4] admin/build-doc: remove librbd-dev from build-dependencies Signed-off-by: Kefu Chai --- admin/build-doc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/admin/build-doc b/admin/build-doc index 1286bb9322b..053ff492552 100755 --- a/admin/build-doc +++ b/admin/build-doc @@ -20,7 +20,6 @@ if command -v dpkg >/dev/null; then graphviz ant cython - librbd-dev zlib1g-dev' for package in $packages; do if [ "$(dpkg --status -- $package 2>&1 | sed -n 's/^Status: //p')" != "install ok installed" ]; then @@ -127,7 +126,7 @@ rm -f $TOPDIR/src/pybind/rbd/rados.pxd $TOPDIR/src/pybind/cephfs/rados.pxd $vdir/bin/sphinx-build -a -n -b dirhtml -d doctrees $TOPDIR/doc $TOPDIR/build-doc/output/html -$vdir/bin/sphinx-build -a -b man -d doctrees $TOPDIR/doc $TOPDIR/build-doc/output/man +$vdir/bin/sphinx-build -a -b man -t man -d doctrees $TOPDIR/doc $TOPDIR/build-doc/output/man # # Build and install JavaDocs From 0e00d2f21bddd8ee811dec816cff5b4f05b1f891 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Tue, 24 May 2016 12:53:21 +0800 Subject: [PATCH 2/4] doc,cmake: do not scan non-man pages when building man pages Signed-off-by: Kefu Chai --- doc/conf.py | 12 ++++++++++++ doc/man/CMakeLists.txt | 2 +- man/Makefile.am | 2 +- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index f1fefe0bc7c..7199b1669de 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -10,6 +10,18 @@ templates_path = ['_templates'] source_suffix = '.rst' master_doc = 'index' exclude_patterns = ['**/.#*', '**/*~', 'start/quick-common.rst'] +if tags.has('man'): + exclude_patterns += ['architecture.rst', 'glossary.rst', 'release*.rst', + 'api/*', + 'cephfs/*', + 'dev/*', + 'install/*', + 'mon/*', + 'rados/*', + 'radosgw/*', + 'rbd/*', + 'start/*'] + pygments_style = 'sphinx' html_theme = 'ceph' diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt index fbb6ce6f5ea..e81631babdc 100644 --- a/doc/man/CMakeLists.txt +++ b/doc/man/CMakeLists.txt @@ -6,7 +6,7 @@ add_subdirectory(8) add_custom_command( OUTPUT ${sphinx_output} - COMMAND ${SPHINX_BUILD} -b man -d ${CMAKE_BINARY_DIR}/doc/doctrees -c ${CMAKE_SOURCE_DIR}/man ${CMAKE_CURRENT_SOURCE_DIR} ${sphinx_output_dir} + COMMAND ${SPHINX_BUILD} -b man -t man -d ${CMAKE_BINARY_DIR}/doc/doctrees -c ${CMAKE_SOURCE_DIR}/man ${CMAKE_CURRENT_SOURCE_DIR} ${sphinx_output_dir} DEPENDS ${sphinx_input}) add_custom_target( diff --git a/man/Makefile.am b/man/Makefile.am index 710d6ea005b..6a8ffea2e93 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -21,7 +21,7 @@ $(dist_man_MANS): sphinx-build.stamp # in a tree populated from dist tarball, the $(top_srcdir)/doc is not included sphinx-build.stamp: if [ -d $(top_srcdir)/doc/man ] ; then \ - ${SPHINX_BUILD} -b man -d doctrees -c $(top_srcdir)/man $(top_srcdir)/doc/man $(top_builddir)/man; \ + ${SPHINX_BUILD} -b man -t man -d doctrees -c $(top_srcdir)/man $(top_srcdir)/doc/man $(top_builddir)/man; \ fi clean-local:: From 911d3fe9bf100eaececcb8703f6d0296ec89bf23 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Tue, 24 May 2016 13:48:04 +0800 Subject: [PATCH 3/4] doc: do not doxgen src/civetweb because it's an external project included as a git submodule Signed-off-by: Kefu Chai --- Doxyfile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index b3f413dd305..85b4b2cbb87 100644 --- a/Doxyfile +++ b/Doxyfile @@ -10,7 +10,9 @@ RECURSIVE = YES EXCLUDE = src/gmock \ src/test/virtualenv \ src/out \ - src/tracing + src/tracing \ + src/civetweb + VERBATIM_HEADERS = NO GENERATE_HTML = NO GENERATE_LATEX = NO From 0fa22f0d1b163de4125a302fc62b50b1fcdc50db Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Tue, 24 May 2016 14:08:05 +0800 Subject: [PATCH 4/4] admin/build-doc: use doc_deps.deb.txt for build-deps instead also update `doc_deps.deb.txt` according to the changes in build-doc. Signed-off-by: Kefu Chai --- admin/build-doc | 15 +-------------- doc_deps.deb.txt | 4 +++- 2 files changed, 4 insertions(+), 15 deletions(-) diff --git a/admin/build-doc b/admin/build-doc index 053ff492552..45b8974a919 100755 --- a/admin/build-doc +++ b/admin/build-doc @@ -7,20 +7,7 @@ TOPDIR=`pwd` install -d -m0755 build-doc if command -v dpkg >/dev/null; then - packages=' - git - gcc - python-dev - python-pip - python-virtualenv - libxml2-dev - libxslt1-dev - doxygen - ditaa - graphviz - ant - cython - zlib1g-dev' + packages=`cat ${TOPDIR}/doc_deps.deb.txt` for package in $packages; do if [ "$(dpkg --status -- $package 2>&1 | sed -n 's/^Status: //p')" != "install ok installed" ]; then # add a space after old values diff --git a/doc_deps.deb.txt b/doc_deps.deb.txt index 2020ca783be..2b8041bb568 100644 --- a/doc_deps.deb.txt +++ b/doc_deps.deb.txt @@ -1,10 +1,12 @@ +git +gcc python-dev python-pip python-virtualenv doxygen ditaa libxml2-dev -libxslt-dev +libxslt1-dev graphviz ant zlib1g-dev