RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-02-19 00:47:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9284 from tchaikov/wip-cmake-doc

Browse Source 
cmake,make: speed up man page generation

Reviewed-by: François Lafont <francois.lafont@ac-versailles.fr>
This commit is contained in:
Kefu Chai 2016-05-29 00:05:21 +08:00
commit 60588e82e9
6 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doxyfile
View File

@ -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

18
admin/build-doc
View File

@ -7,21 +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
librbd-dev
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
@ -127,7 +113,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

12
doc/conf.py
View File

@ -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'

2
doc/man/CMakeLists.txt
View File

@ -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(

4
doc_deps.deb.txt
View File

@ -1,10 +1,12 @@
git
gcc
python-dev
python-pip
python-virtualenv
doxygen
ditaa
libxml2-dev
libxslt-dev
libxslt1-dev
graphviz
ant
zlib1g-dev

2
man/Makefile.am
View File

@ -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::