From ffaad0afbece28d246557bdff64b47103ea8f179 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Thu, 23 Jan 2020 22:33:59 +0100 Subject: [PATCH] docs: cmake build --- CMake/FindSphinx.cmake | 10 + CMakeLists.txt | 2 + Config.cmake | 10 + Include.cmake | 2 + docs/CMakeLists.txt | 59 +++++ docs/source/conf.py.in | 297 +++++++++++++------------- docs/source/hashkit_create.rst | 2 +- docs/source/index.rst | 53 +---- docs/source/libmemcached_examples.rst | 7 +- docs/source/libmemcachedutil.rst | 6 +- docs/source/memcached_user_data.rst | 3 - 11 files changed, 249 insertions(+), 202 deletions(-) create mode 100644 CMake/FindSphinx.cmake create mode 100644 docs/CMakeLists.txt diff --git a/CMake/FindSphinx.cmake b/CMake/FindSphinx.cmake new file mode 100644 index 00000000..8b76fdc0 --- /dev/null +++ b/CMake/FindSphinx.cmake @@ -0,0 +1,10 @@ +find_program(SPHINX_EXECUTABLE NAMES sphinx-build + HINTS $ENV{SPHINX_DIR} + PATH_SUFFIXES bin + DOC "Sphinx documentation generator" + ) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(Sphinx DEFAULT_MSG SPHINX_EXECUTABLE) + +mark_as_advanced(SPHINX_EXECUTABLE) diff --git a/CMakeLists.txt b/CMakeLists.txt index e0de2a01..ff0a93a2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -70,5 +70,7 @@ add_subdirectory(libmemcached) add_subdirectory(libmemcached-1.0) add_subdirectory(libmemcachedutil) +add_subdirectory(docs) + # keep last configure_file(mem_config.h.in ${CMAKE_BINARY_DIR}/mem_config.h @ONLY) diff --git a/Config.cmake b/Config.cmake index 93aead46..502201ea 100644 --- a/Config.cmake +++ b/Config.cmake @@ -1,9 +1,19 @@ +#set(CMAKE_INSTALL_PREFIX /usr) + set(LIBMEMCACHED_WITH_SASL_SUPPORT 0) set(HAVE_FNV64_HASH 1) set(HAVE_MURMUR_HASH 1) set(HAVE_HSIEH_HASH 0) +#set(SPHINX_OPTIONS) +#set(SPHINX_THEME) +#set(SPHINX_THEME_DIR) +#set(SPHINX_THEME_OPTIONS) +#set(SPHINX_CONF_APPEND) +#set(SPHINX_EXTENSIONS "''") +#set(SPHINX_CONF_APPEND) + set(HAVE_DTRACE 0) set(HAVE_VISIBILITY 1) set(HAVE_GCC_BUILTIN_ATOMIC 1) diff --git a/Include.cmake b/Include.cmake index 399717e3..5821e6de 100644 --- a/Include.cmake +++ b/Include.cmake @@ -1,4 +1,6 @@ +set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/CMake) + include(CheckTypeSize) include(CheckCSourceRuns) include(CheckIncludeFileCXX) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 00000000..31f30ca0 --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,59 @@ +find_package(Sphinx) + +if(SPHINX_EXECUTABLE) + + if(NOT DEFINED SPHINX_THEME) + set(SPHINX_THEME sphinx_rtd_theme) + set(SPHINX_THEME_OPTIONS "'collapse_navigation':False, 'navigation_depth':2, 'titles_only':False, 'includehidden':False") + endif() + + if(NOT DEFINED SPHINX_THEME_DIR) + set(SPHINX_THEME_DIR) + endif() + + if(NOT DEFINED SPHINX_OPTIONS) + set(SPHINX_OPTIONS) + endif() + + set(SPHINX_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/source") + + # configured documentation tools and intermediate build results + set(SPHINX_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}") + + # Sphinx cache with pickled ReST documents + set(SPHINX_CACHE_DIR "${SPHINX_BUILD_DIR}/_doctrees") + + # HTML output directory + set(SPHINX_HTML_DIR "${SPHINX_BUILD_DIR}/html") + + # MAN output directory + set(SPHINX_MAN_DIR "${SPHINX_BUILD_DIR}/man") + + configure_file( + "${SPHINX_SOURCE_DIR}/conf.py.in" + "${SPHINX_BUILD_DIR}/conf.py" + @ONLY) + + add_custom_target("docs" + ${SPHINX_EXECUTABLE} + -q -a -b html + -c "${SPHINX_BUILD_DIR}" + -d "${SPHINX_CACHE_DIR}" + ${SPHINX_OPTIONS} + "${SPHINX_SOURCE_DIR}" + "${SPHINX_HTML_DIR}" + BYPRODUCTS ${SPHINX_HTML_DIR} + COMMENT "Build HTML documentation with Sphinx") + #list(APPEND ADDITIONAL_CLEAN_FILES ${SPHINX_CACHE_DIR} ${SPHINX_HTML_DIR}) + add_custom_target(man + ${SPHINX_EXECUTABLE} + -q -a -b man + -c "${SPHINX_BUILD_DIR}" + -d "${SPHINX_CACHE_DIR}" + ${SPHINX_OPTIONS} + "${SPHINX_SOURCE_DIR}" + "${SPHINX_MAN_DIR}" + BYPRODUCTS ${SPHINX_MAN_DIR} + COMMENT "Build manpage documentation with Sphinx") + #list(APPEND ADDITIONAL_CLEAN_FILES ${SPHINX_CACHE_DIR} ${SPHINX_MAN_DIR}) +endif() diff --git a/docs/source/conf.py.in b/docs/source/conf.py.in index 7fa47d27..0abfd9b1 100644 --- a/docs/source/conf.py.in +++ b/docs/source/conf.py.in @@ -25,7 +25,7 @@ import sys, os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] +extensions = [@SPHINX_EXTENSIONS@] #extensions = ['sphinxcontrib.googleanalytics'] @@ -47,7 +47,7 @@ master_doc = 'index' # General information about the project. project = u'libmemcached' -copyright = u'2011-2013, Brian Aker DataDifferential, http://datadifferential.com/' +copyright = u'2011-2013, Brian Aker DataDifferential, http://datadifferential.com/\n2020, Michael Wallner SmugMug Inc. http://m6w6.github.io/libmemcached/' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -97,12 +97,12 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = '@SPHINX_THEME@' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = {@SPHINX_THEME_OPTIONS@} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] @@ -213,149 +213,154 @@ latex_documents = [ # -- Options for manual page output -------------------------------------------- - +man_authors = [ + u'Brian Aker', + u'Michael Wallner' +] # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('hashkit_create', 'hashkit_clone', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_create', 'hashkit_create', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_create', 'hashkit_free', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_create', 'hashkit_is_allocated', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_crc32', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_fnv1_32', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_fnv1_64', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_fnv1a_32', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_fnv1a_64', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_functions', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_hsieh', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_jenkins', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_md5', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_functions', 'hashkit_murmur', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('hashkit_value', 'hashkit_value', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('libhashkit', 'libhashkit', u'libhashkit Documentation', [u'Brian Aker'], 3), - ('libmemcached', 'libmemcached', u'Introducing the C Client Library for memcached', [u'Brian Aker'], 3), - ('libmemcached_configuration', 'libmemcached_check_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('libmemcached_configuration', 'libmemcached_configuration', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('libmemcached_configuration', 'memcached', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('libmemcached_examples', 'libmemcached_examples', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('libmemcachedutil', 'libmemcachedutil', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_analyze', 'memcached_analyze', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_append', 'memcached_append', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3), - ('memcached_append', 'memcached_append_by_key', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3), - ('memcached_append', 'memcached_prepend', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3), - ('memcached_append', 'memcached_prepend_by_key', u'Appending to or Prepending to data on the server', [u'Brian Aker'], 3), - ('memcached_auto', 'memcached_auto', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3), - ('memcached_auto', 'memcached_decrement', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3), - ('memcached_auto', 'memcached_decrement_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3), - ('memcached_auto', 'memcached_increment', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3), - ('memcached_auto', 'memcached_increment_with_initial', u'Incrementing and Decrementing Values', [u'Brian Aker'], 3), - ('memcached_behavior', 'memcached_behavior', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_behavior', 'memcached_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_behavior', 'memcached_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_callback', 'memcached_callback', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_callback', 'memcached_callback_get', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_callback', 'memcached_callback_set', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_cas', 'memcached_cas', u'Working with data on the server in an atomic fashion', [u'Brian Aker'], 3), - ('memcached_cas', 'memcached_cas_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3), - ('memcached_create', 'memcached_clone', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_create', 'memcached_create', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_create', 'memcached_free', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_create', 'memcached_servers_reset', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_delete', 'memcached_delete', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_delete', 'memcached_delete_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('libmemcached-1.0/memcached_touch', 'memcached_touch', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('libmemcached-1.0/memcached_touch', 'memcached_touch_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('libmemcached/memcached_exist', 'memcached_exist', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('libmemcached/memcached_exist', 'memcached_exist_by_key', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_dump', 'memcached_dump', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_flush', 'memcached_flush', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_flush_buffers', 'memcached_flush_buffers', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_generate_hash_value', 'memcached_generate_hash', u'Generating hash values directly', [u'Brian Aker'], 3), - ('memcached_generate_hash_value', 'memcached_generate_hash_value', u'Generating hash values directly', [u'Brian Aker'], 3), - ('libmemcached/memcached_fetch', 'memcached_fetch', u'Retrieving data from the server', [u'Brian Aker'], 3), - ('memcached_get', 'memcached_fetch_execute', u'Retrieving data from the server', [u'Brian Aker'], 3), - ('memcached_get', 'memcached_fetch_result', u'Retrieving data from the server', [u'Brian Aker'], 3), - ('memcached_get', 'memcached_get', u'Retrieving data from the server', [u'Brian Aker'], 3), - ('memcached_get', 'memcached_get_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3), - ('libmemcached/memcached_return_t', 'memcached_return_t', u'Return type values ', [u'Brian Aker'], 3), - ('memcached_get', 'memcached_mget', u'Retrieving data from the server', [u'Brian Aker'], 3), - ('memcached_get', 'memcached_mget_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3), - ('memcached_get', 'memcached_mget_execute', u'Retrieving data from the server', [u'Brian Aker'], 3), - ('memcached_get', 'memcached_mget_execute_by_key', u'Retrieving data from the server', [u'Brian Aker'], 3), - ('libmemcached/memcached_last_error_message', 'memcached_last_error_message', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_memory_allocators', 'memcached_get_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_memory_allocators', 'memcached_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_memory_allocators', 'memcached_set_memory_allocators', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_memory_allocators', 'memcached_set_memory_allocators_context', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool_behavior_get', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool_behavior_set', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool_create', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool_destroy', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool_fetch', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool_pop', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool_push', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool_release', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_pool', 'memcached_pool_st', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_quit', 'memcached_quit', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('libmemcached-1.0/memcached_set_encoding_key', 'memcached_set_encoding_key', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_result_st', 'memcached_result_cas', u'Working with result sets', [u'Brian Aker'], 3), - ('memcached_result_st', 'memcached_result_create', u'Working with result sets', [u'Brian Aker'], 3), - ('memcached_result_st', 'memcached_result_flags', u'Working with result sets', [u'Brian Aker'], 3), - ('memcached_result_st', 'memcached_result_free', u'Working with result sets', [u'Brian Aker'], 3), - ('memcached_result_st', 'memcached_result_key_length', u'Working with result sets', [u'Brian Aker'], 3), - ('memcached_result_st', 'memcached_result_key_value', u'Working with result sets', [u'Brian Aker'], 3), - ('memcached_result_st', 'memcached_result_length', u'Working with result sets', [u'Brian Aker'], 3), - ('memcached_result_st', 'memcached_result_st', u'Working with result sets', [u'Brian Aker'], 3), - ('memcached_result_st', 'memcached_result_value', u'Working with result sets', [u'Brian Aker'], 3), - ('memcached_sasl', 'memcached_destroy_sasl_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_sasl', 'memcached_get_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_sasl', 'memcached_sasl', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_sasl', 'memcached_sasl_set_auth_data', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_sasl', 'memcached_set_sasl_callbacks', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_server_st', 'memcached_server_list_append', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_server_st', 'memcached_server_list_count', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_server_st', 'memcached_server_list_free', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_server_st', 'memcached_servers_parse', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_servers', 'memcached_server_add', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_servers', 'memcached_server_add_unix_socket', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_servers', 'memcached_server_count', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_servers', 'memcached_server_cursor', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_servers', 'memcached_server_list', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_servers', 'memcached_server_push', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_servers', 'memcached_server_st', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_servers', 'memcached_servers', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_set', 'memcached_add', u'Storing and Replacing Data', [u'Brian Aker'], 3), - ('memcached_set', 'memcached_add_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3), - ('memcached_set', 'memcached_replace', u'Storing and Replacing Data', [u'Brian Aker'], 3), - ('memcached_set', 'memcached_replace_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3), - ('memcached_set', 'memcached_set', u'Storing and Replacing Data', [u'Brian Aker'], 3), - ('memcached_set', 'memcached_set_by_key', u'Storing and Replacing Data', [u'Brian Aker'], 3), - ('memcached_stats', 'memcached_stat', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_stats', 'memcached_stat_execute', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_stats', 'memcached_stat_get_keys', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_stats', 'memcached_stat_get_value', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_stats', 'memcached_stat_servername', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_stats', 'memcached_stats', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_strerror', 'memcached_strerror', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_user_data', 'memcached_get_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_user_data', 'memcached_set_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_user_data', 'memcached_user_data', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_verbosity', 'memcached_verbosity', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_version', 'memcached_lib_version', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('memcached_version', 'memcached_version', u'libmemcached Documentation', [u'Brian Aker'], 3), - ('bin/memcapable', 'memcapable', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memcat', 'memcat', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memcp', 'memcp', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memdump', 'memdump', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memerror', 'memerror', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memflush', 'memflush', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memrm', 'memrm', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memaslap', 'memaslap', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memslap', 'memslap', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memstat', 'memstat', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memexist', 'memexist', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memparse', 'memparse', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memping', 'memping', u'libmemcached Documentation', [u'Brian Aker'], 1), - ('bin/memtouch', 'memtouch', u'libmemcached Documentation', [u'Brian Aker'], 1), + ('hashkit_create', 'hashkit_clone', u'libhashkit Documentation', man_authors, 3), + ('hashkit_create', 'hashkit_create', u'libhashkit Documentation', man_authors, 3), + ('hashkit_create', 'hashkit_free', u'libhashkit Documentation', man_authors, 3), + ('hashkit_create', 'hashkit_is_allocated', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_crc32', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_fnv1_32', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_fnv1_64', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_fnv1a_32', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_fnv1a_64', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_functions', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_hsieh', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_jenkins', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_md5', u'libhashkit Documentation', man_authors, 3), + ('hashkit_functions', 'hashkit_murmur', u'libhashkit Documentation', man_authors, 3), + ('hashkit_value', 'hashkit_value', u'libhashkit Documentation', man_authors, 3), + ('libhashkit', 'libhashkit', u'libhashkit Documentation', man_authors, 3), + ('libmemcached', 'libmemcached', u'Introducing the C Client Library for memcached', man_authors, 3), + ('libmemcached_configuration', 'libmemcached_check_configuration', u'libmemcached Documentation', man_authors, 3), + ('libmemcached_configuration', 'libmemcached_configuration', u'libmemcached Documentation', man_authors, 3), + ('libmemcached_configuration', 'memcached', u'libmemcached Documentation', man_authors, 3), + ('libmemcached_examples', 'libmemcached_examples', u'libmemcached Documentation', man_authors, 3), + ('libmemcachedutil', 'libmemcachedutil', u'libmemcached Documentation', man_authors, 3), + ('memcached_analyze', 'memcached_analyze', u'libmemcached Documentation', man_authors, 3), + ('memcached_append', 'memcached_append', u'Appending to or Prepending to data on the server', man_authors, 3), + ('memcached_append', 'memcached_append_by_key', u'Appending to or Prepending to data on the server', man_authors, 3), + ('memcached_append', 'memcached_prepend', u'Appending to or Prepending to data on the server', man_authors, 3), + ('memcached_append', 'memcached_prepend_by_key', u'Appending to or Prepending to data on the server', man_authors, 3), + ('memcached_auto', 'memcached_auto', u'Incrementing and Decrementing Values', man_authors, 3), + ('memcached_auto', 'memcached_decrement', u'Incrementing and Decrementing Values', man_authors, 3), + ('memcached_auto', 'memcached_decrement_with_initial', u'Incrementing and Decrementing Values', man_authors, 3), + ('memcached_auto', 'memcached_increment', u'Incrementing and Decrementing Values', man_authors, 3), + ('memcached_auto', 'memcached_increment_with_initial', u'Incrementing and Decrementing Values', man_authors, 3), + ('memcached_behavior', 'memcached_behavior', u'libmemcached Documentation', man_authors, 3), + ('memcached_behavior', 'memcached_behavior_get', u'libmemcached Documentation', man_authors, 3), + ('memcached_behavior', 'memcached_behavior_set', u'libmemcached Documentation', man_authors, 3), + ('memcached_callback', 'memcached_callback', u'libmemcached Documentation', man_authors, 3), + ('memcached_callback', 'memcached_callback_get', u'libmemcached Documentation', man_authors, 3), + ('memcached_callback', 'memcached_callback_set', u'libmemcached Documentation', man_authors, 3), + ('memcached_cas', 'memcached_cas', u'Working with data on the server in an atomic fashion', man_authors, 3), + ('memcached_cas', 'memcached_cas_by_key', u'Storing and Replacing Data', man_authors, 3), + ('memcached_create', 'memcached_clone', u'libmemcached Documentation', man_authors, 3), + ('memcached_create', 'memcached_create', u'libmemcached Documentation', man_authors, 3), + ('memcached_create', 'memcached_free', u'libmemcached Documentation', man_authors, 3), + ('memcached_create', 'memcached_servers_reset', u'libmemcached Documentation', man_authors, 3), + ('memcached_delete', 'memcached_delete', u'libmemcached Documentation', man_authors, 3), + ('memcached_delete', 'memcached_delete_by_key', u'libmemcached Documentation', man_authors, 3), + ('libmemcached-1.0/memcached_touch', 'memcached_touch', u'libmemcached Documentation', man_authors, 3), + ('libmemcached-1.0/memcached_touch', 'memcached_touch_by_key', u'libmemcached Documentation', man_authors, 3), + ('libmemcached/memcached_exist', 'memcached_exist', u'libmemcached Documentation', man_authors, 3), + ('libmemcached/memcached_exist', 'memcached_exist_by_key', u'libmemcached Documentation', man_authors, 3), + ('memcached_dump', 'memcached_dump', u'libmemcached Documentation', man_authors, 3), + ('memcached_flush', 'memcached_flush', u'libmemcached Documentation', man_authors, 3), + ('memcached_flush_buffers', 'memcached_flush_buffers', u'libmemcached Documentation', man_authors, 3), + ('memcached_generate_hash_value', 'memcached_generate_hash', u'Generating hash values directly', man_authors, 3), + ('memcached_generate_hash_value', 'memcached_generate_hash_value', u'Generating hash values directly', man_authors, 3), + ('libmemcached/memcached_fetch', 'memcached_fetch', u'Retrieving data from the server', man_authors, 3), + ('memcached_get', 'memcached_fetch_execute', u'Retrieving data from the server', man_authors, 3), + ('memcached_get', 'memcached_fetch_result', u'Retrieving data from the server', man_authors, 3), + ('memcached_get', 'memcached_get', u'Retrieving data from the server', man_authors, 3), + ('memcached_get', 'memcached_get_by_key', u'Retrieving data from the server', man_authors, 3), + ('libmemcached/memcached_return_t', 'memcached_return_t', u'Return type values ', man_authors, 3), + ('memcached_get', 'memcached_mget', u'Retrieving data from the server', man_authors, 3), + ('memcached_get', 'memcached_mget_by_key', u'Retrieving data from the server', man_authors, 3), + ('memcached_get', 'memcached_mget_execute', u'Retrieving data from the server', man_authors, 3), + ('memcached_get', 'memcached_mget_execute_by_key', u'Retrieving data from the server', man_authors, 3), + ('libmemcached/memcached_last_error_message', 'memcached_last_error_message', u'libmemcached Documentation', man_authors, 3), + ('memcached_memory_allocators', 'memcached_get_memory_allocators', u'libmemcached Documentation', man_authors, 3), + ('memcached_memory_allocators', 'memcached_memory_allocators', u'libmemcached Documentation', man_authors, 3), + ('memcached_memory_allocators', 'memcached_set_memory_allocators', u'libmemcached Documentation', man_authors, 3), + ('memcached_memory_allocators', 'memcached_set_memory_allocators_context', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool_behavior_get', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool_behavior_set', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool_create', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool_destroy', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool_fetch', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool_pop', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool_push', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool_release', u'libmemcached Documentation', man_authors, 3), + ('memcached_pool', 'memcached_pool_st', u'libmemcached Documentation', man_authors, 3), + ('memcached_quit', 'memcached_quit', u'libmemcached Documentation', man_authors, 3), + ('libmemcached-1.0/memcached_set_encoding_key', 'memcached_set_encoding_key', u'libmemcached Documentation', man_authors, 3), + ('memcached_result_st', 'memcached_result_cas', u'Working with result sets', man_authors, 3), + ('memcached_result_st', 'memcached_result_create', u'Working with result sets', man_authors, 3), + ('memcached_result_st', 'memcached_result_flags', u'Working with result sets', man_authors, 3), + ('memcached_result_st', 'memcached_result_free', u'Working with result sets', man_authors, 3), + ('memcached_result_st', 'memcached_result_key_length', u'Working with result sets', man_authors, 3), + ('memcached_result_st', 'memcached_result_key_value', u'Working with result sets', man_authors, 3), + ('memcached_result_st', 'memcached_result_length', u'Working with result sets', man_authors, 3), + ('memcached_result_st', 'memcached_result_st', u'Working with result sets', man_authors, 3), + ('memcached_result_st', 'memcached_result_value', u'Working with result sets', man_authors, 3), + ('memcached_sasl', 'memcached_destroy_sasl_auth_data', u'libmemcached Documentation', man_authors, 3), + ('memcached_sasl', 'memcached_get_sasl_callbacks', u'libmemcached Documentation', man_authors, 3), + ('memcached_sasl', 'memcached_sasl', u'libmemcached Documentation', man_authors, 3), + ('memcached_sasl', 'memcached_sasl_set_auth_data', u'libmemcached Documentation', man_authors, 3), + ('memcached_sasl', 'memcached_set_sasl_callbacks', u'libmemcached Documentation', man_authors, 3), + ('memcached_server_st', 'memcached_server_list_append', u'libmemcached Documentation', man_authors, 3), + ('memcached_server_st', 'memcached_server_list_count', u'libmemcached Documentation', man_authors, 3), + ('memcached_server_st', 'memcached_server_list_free', u'libmemcached Documentation', man_authors, 3), + ('memcached_server_st', 'memcached_servers_parse', u'libmemcached Documentation', man_authors, 3), + ('memcached_servers', 'memcached_server_add', u'libmemcached Documentation', man_authors, 3), + ('memcached_servers', 'memcached_server_add_unix_socket', u'libmemcached Documentation', man_authors, 3), + ('memcached_servers', 'memcached_server_count', u'libmemcached Documentation', man_authors, 3), + ('memcached_servers', 'memcached_server_cursor', u'libmemcached Documentation', man_authors, 3), + ('memcached_servers', 'memcached_server_list', u'libmemcached Documentation', man_authors, 3), + ('memcached_servers', 'memcached_server_push', u'libmemcached Documentation', man_authors, 3), + ('memcached_servers', 'memcached_server_st', u'libmemcached Documentation', man_authors, 3), + ('memcached_servers', 'memcached_servers', u'libmemcached Documentation', man_authors, 3), + ('memcached_set', 'memcached_add', u'Storing and Replacing Data', man_authors, 3), + ('memcached_set', 'memcached_add_by_key', u'Storing and Replacing Data', man_authors, 3), + ('memcached_set', 'memcached_replace', u'Storing and Replacing Data', man_authors, 3), + ('memcached_set', 'memcached_replace_by_key', u'Storing and Replacing Data', man_authors, 3), + ('memcached_set', 'memcached_set', u'Storing and Replacing Data', man_authors, 3), + ('memcached_set', 'memcached_set_by_key', u'Storing and Replacing Data', man_authors, 3), + ('memcached_stats', 'memcached_stat', u'libmemcached Documentation', man_authors, 3), + ('memcached_stats', 'memcached_stat_execute', u'libmemcached Documentation', man_authors, 3), + ('memcached_stats', 'memcached_stat_get_keys', u'libmemcached Documentation', man_authors, 3), + ('memcached_stats', 'memcached_stat_get_value', u'libmemcached Documentation', man_authors, 3), + ('memcached_stats', 'memcached_stat_servername', u'libmemcached Documentation', man_authors, 3), + ('memcached_stats', 'memcached_stats', u'libmemcached Documentation', man_authors, 3), + ('memcached_strerror', 'memcached_strerror', u'libmemcached Documentation', man_authors, 3), + ('memcached_user_data', 'memcached_get_user_data', u'libmemcached Documentation', man_authors, 3), + ('memcached_user_data', 'memcached_set_user_data', u'libmemcached Documentation', man_authors, 3), + ('memcached_user_data', 'memcached_user_data', u'libmemcached Documentation', man_authors, 3), + ('memcached_verbosity', 'memcached_verbosity', u'libmemcached Documentation', man_authors, 3), + ('memcached_version', 'memcached_lib_version', u'libmemcached Documentation', man_authors, 3), + ('memcached_version', 'memcached_version', u'libmemcached Documentation', man_authors, 3), + ('bin/memcapable', 'memcapable', u'libmemcached Documentation', man_authors, 1), + ('bin/memcat', 'memcat', u'libmemcached Documentation', man_authors, 1), + ('bin/memcp', 'memcp', u'libmemcached Documentation', man_authors, 1), + ('bin/memdump', 'memdump', u'libmemcached Documentation', man_authors, 1), + ('bin/memerror', 'memerror', u'libmemcached Documentation', man_authors, 1), + ('bin/memflush', 'memflush', u'libmemcached Documentation', man_authors, 1), + ('bin/memrm', 'memrm', u'libmemcached Documentation', man_authors, 1), + ('bin/memaslap', 'memaslap', u'libmemcached Documentation', man_authors, 1), + ('bin/memslap', 'memslap', u'libmemcached Documentation', man_authors, 1), + ('bin/memstat', 'memstat', u'libmemcached Documentation', man_authors, 1), + ('bin/memexist', 'memexist', u'libmemcached Documentation', man_authors, 1), + ('bin/memparse', 'memparse', u'libmemcached Documentation', man_authors, 1), + ('bin/memping', 'memping', u'libmemcached Documentation', man_authors, 1), + ('bin/memtouch', 'memtouch', u'libmemcached Documentation', man_authors, 1), ] + +@SPHINX_CONF_APPEND@ diff --git a/docs/source/hashkit_create.rst b/docs/source/hashkit_create.rst index a46729a9..287382df 100644 --- a/docs/source/hashkit_create.rst +++ b/docs/source/hashkit_create.rst @@ -15,7 +15,7 @@ SYNOPSIS .. c:type:: hashkit_st .. c:function:: hashkit_st *hashkit_create(hashkit_st *hash) - + .. c:function:: hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr) .. c:function:: void hashkit_free(hashkit_st *hash) diff --git a/docs/source/index.rst b/docs/source/index.rst index c3cca3be..81fb1e7b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,14 +6,9 @@ Welcome to the libmemcached documentation Libmemcached ------------ - -###### -Basics -###### - - .. toctree:: :maxdepth: 1 + :caption: Basics libmemcached versioning @@ -22,12 +17,9 @@ Basics libmemcached_configuration libmemcached/memcached_last_error_message -################# -Working with data -################# - .. toctree:: :maxdepth: 1 + :caption: Working with Data memcached_auto memcached_delete @@ -40,13 +32,9 @@ Working with data memcached_append memcached_cas - -############### -Advanced Topics -############### - .. toctree:: :maxdepth: 1 + :caption: Advanced Topics libmemcached-1.0/memcached_set_encoding_key memcached_behavior @@ -66,61 +54,43 @@ Advanced Topics memcached_version libmemcached/defaults -################## -Interface Versions -################## - .. toctree:: :titlesonly: + :caption: Interface Versions libmemcached-1.0/index libmemcached-1.1/index -#################### -Deprecated Functions -#################### - .. toctree:: :titlesonly: + :caption: Deprecated Functions libmemcached/memcached_fetch -################# -Platform Specific -################# - .. toctree:: :maxdepth: 1 + :caption: Platform Specifics tap types -################################# -Deriving statistics from a server -################################# - .. toctree:: :maxdepth: 1 + :caption: Deriving Statistics from a Server memcached_analyze memcached_stats ----------------- -Libmemcachedutil ----------------- - .. toctree:: :maxdepth: 1 + :caption: Libmemcachedutil libmemcachedutil memcached_pool -------------------- -Client Applications -------------------- - .. toctree:: :maxdepth: 1 + :caption: Client Applications bin/memcapable bin/memcat @@ -137,12 +107,9 @@ Client Applications bin/memping.rst bin/memtouch.rst ----------- -Libhashkit ----------- - .. toctree:: :maxdepth: 1 + :caption: Libhashkit libhashkit hashkit_create diff --git a/docs/source/libmemcached_examples.rst b/docs/source/libmemcached_examples.rst index a43ee1a2..ccc40c91 100644 --- a/docs/source/libmemcached_examples.rst +++ b/docs/source/libmemcached_examples.rst @@ -38,12 +38,9 @@ Creating a pool of servers -------------------------- - .. code-block:: c -Creating a pool of Servers:: - - const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"; + const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"; memcached_pool_st* pool= memcached_pool(config_string, strlen(config_string)); @@ -80,8 +77,6 @@ Adding a value to the server .. code-block:: c -Adding a value to the Server:: - char *key= "foo"; char *value= "value"; diff --git a/docs/source/libmemcachedutil.rst b/docs/source/libmemcachedutil.rst index 692aa2ef..29cc7dbf 100644 --- a/docs/source/libmemcachedutil.rst +++ b/docs/source/libmemcachedutil.rst @@ -1,6 +1,6 @@ -=========== -Introducing -=========== +============================ +Introducing libmemcachedutil +============================ Utility library for libmemcached diff --git a/docs/source/memcached_user_data.rst b/docs/source/memcached_user_data.rst index a0bc602b..93a777ff 100644 --- a/docs/source/memcached_user_data.rst +++ b/docs/source/memcached_user_data.rst @@ -20,9 +20,6 @@ SYNOPSIS -------- - -.. code-block:: c - #include .. c:function:: void *memcached_get_user_data (memcached_st *ptr) -- 2.30.2