diff options
Diffstat (limited to 'base/common/python/docs')
| -rw-r--r-- | base/common/python/docs/CMakeLists.txt | 8 | ||||
| -rw-r--r-- | base/common/python/docs/conf.py.in | 6 | ||||
| -rw-r--r-- | base/common/python/docs/index.rst | 4 |
3 files changed, 13 insertions, 5 deletions
diff --git a/base/common/python/docs/CMakeLists.txt b/base/common/python/docs/CMakeLists.txt index 51e8c287a..86bb590f3 100644 --- a/base/common/python/docs/CMakeLists.txt +++ b/base/common/python/docs/CMakeLists.txt @@ -20,6 +20,12 @@ set(SPHINX_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/../../../../../base/common/html # MAN output directory set(SPHINX_MAN_DIR "${CMAKE_CURRENT_BINARY_DIR}/../../../../../base/common/man/man1") +# HTML log file +set(SPHINX_HTML_LOG_FILE "${CMAKE_CURRENT_BINARY_DIR}/../../../../../../../pki-common-sphinx-http.log") + +# MAN log file +set(SPHINX_MAN_LOG_FILE "${CMAKE_CURRENT_BINARY_DIR}/../../../../../../../pki-common-sphinx-man.log") + configure_file( "${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in" "${BINARY_BUILD_DIR}/conf.py" @@ -30,6 +36,7 @@ add_custom_target(dogtag_python_client_docs ALL -b html -c "${BINARY_BUILD_DIR}" -d "${SPHINX_CACHE_DIR}" + -w "${SPHINX_HTML_LOG_FILE}" -a "${CMAKE_CURRENT_SOURCE_DIR}" "${SPHINX_HTML_DIR}" @@ -40,6 +47,7 @@ add_custom_target(dogtag_python_client_man_docs ALL -b man -c "${BINARY_BUILD_DIR}" -d "${SPHINX_CACHE_DIR}" + -w "${SPHINX_MAN_LOG_FILE}" -a "${CMAKE_CURRENT_SOURCE_DIR}" "${SPHINX_MAN_DIR}" diff --git a/base/common/python/docs/conf.py.in b/base/common/python/docs/conf.py.in index eca3b1a0b..d6f55e465 100644 --- a/base/common/python/docs/conf.py.in +++ b/base/common/python/docs/conf.py.in @@ -183,7 +183,7 @@ latex_elements = { # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'dogtag.tex', u'Dogtag Certificate Server Python Client Documentation', + ('index', 'dogtag.tex', u'Dogtag Python Client API', u'Author', 'manual'), ] @@ -213,7 +213,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'pki-python-client', u'Dogtag Python Client Documentation', + ('index', 'pki-python-client', u'Dogtag Python Client API', [u'Dogtag PKI Project Team'], 1) ] @@ -227,7 +227,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'Dogtag', u'Dogtag Certificate Server Python Client Documentation', + ('index', 'Dogtag', u'Dogtag Python Client API', u'Author', 'Dogtag PKI Team', 'Dogtag is an enterprise software system designed to manage enterprise Public Key Infrastructure (PKI) deployments.', 'Miscellaneous'), ] diff --git a/base/common/python/docs/index.rst b/base/common/python/docs/index.rst index 8422a78bd..eca286ac9 100644 --- a/base/common/python/docs/index.rst +++ b/base/common/python/docs/index.rst @@ -1,5 +1,5 @@ -Welcome to Dogtag's Python Client documentation! -================================================ +Dogtag Python Client API +======================== Dogtag is an enterprise software system designed to manage enterprise Public Key Infrastructure (PKI) deployments. |