git.m6w6.name Git - m6w6/libmemcached/blob - docs/conf.py.in

   1 # -*- coding: utf-8 -*-
   2
   3 import sys, os
   4
   5 # If extensions (or modules to document with autodoc) are in another directory,
   6 # add these directories to sys.path here. If the directory is relative to the
   7 # documentation root, use os.path.abspath to make it absolute, like shown here.
   8 #sys.path.insert(0, os.path.abspath('.'))
   9
  10
  11 # -- General configuration -----------------------------------------------------
  12
  13 #needs_sphinx = '1.0'
  14 extensions = [@SPHINX_EXTENSIONS@]
  15 templates_path = ['_templates']
  16 source_suffix = ['.rst']
  17 master_doc = 'index'
  18 pygments_style = 'sphinx'
  19
  20 primary_domain = 'cpp'
  21 default_role = 'any'
  22
  23 project = u'libmemcached'
  24 version = '@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@'
  25 release = '@PROJECT_VERSION@'
  26
  27 smartquotes = False
  28 m2r_parse_relative_links = True
  29
  30 # -- Options for HTML output ---------------------------------------------------
  31
  32 html_theme = '@SPHINX_THEME@'
  33 html_theme_options = {@SPHINX_THEME_OPTIONS@}
  34 html_domain_indices = False
  35 html_show_sourcelink = False
  36 html_copy_source = False
  37 #manpages_url = 'http://man7.org/linux/man-pages/man{section}/{page}.{section}.html'
  38 manpages_url = 'https://linux.die.net/man/{section}/{page}'
  39
  40 html_context = {
  41   'display_github': True,
  42   'github_user': 'm6w6',
  43   'github_repo': 'libmemcached',
  44   'github_version': 'v1.x/docs/source/'
  45 }
  46
  47 # -- Options for manual page output --------------------------------------------
  48
  49 # Skip a separate AUTHOR section
  50 man_authors = []
  51
  52 # One entry per manual page. List of tuples
  53 # (source start file, name, description, authors, manual section).
  54 man_pages = [
  55   ('libhashkit/index'                          ,'libhashkit'                              ,u'libhashkit Documentation'            ,man_authors,3),
  56   ('libhashkit/hashkit_create'                 ,'hashkit_clone'                           ,u'libhashkit Documentation'            ,man_authors,3),
  57   ('libhashkit/hashkit_create'                 ,'hashkit_create'                          ,u'libhashkit Documentation'            ,man_authors,3),
  58   ('libhashkit/hashkit_create'                 ,'hashkit_free'                            ,u'libhashkit Documentation'            ,man_authors,3),
  59   ('libhashkit/hashkit_create'                 ,'hashkit_is_allocated'                    ,u'libhashkit Documentation'            ,man_authors,3),
  60   ('libhashkit/hashkit_function'               ,'hashkit_function'                        ,u'libhashkit Documentation'            ,man_authors,3),
  61   ('libhashkit/hashkit_function'               ,'hashkit_get_distribution_function'       ,u'libhashkit Documentation'            ,man_authors,3),
  62   ('libhashkit/hashkit_function'               ,'hashkit_get_function'                    ,u'libhashkit Documentation'            ,man_authors,3),
  63   ('libhashkit/hashkit_function'               ,'hashkit_set_custom_distribution_function',u'libhashkit Documentation'            ,man_authors,3),
  64   ('libhashkit/hashkit_function'               ,'hashkit_set_custom_function'             ,u'libhashkit Documentation'            ,man_authors,3),
  65   ('libhashkit/hashkit_function'               ,'hashkit_set_distribution_function'       ,u'libhashkit Documentation'            ,man_authors,3),
  66   ('libhashkit/hashkit_function'               ,'hashkit_set_function'                    ,u'libhashkit Documentation'            ,man_authors,3),
  67   ('libhashkit/hashkit_functions'              ,'hashkit_crc32'                           ,u'libhashkit Documentation'            ,man_authors,3),
  68   ('libhashkit/hashkit_functions'              ,'hashkit_fnv1_32'                         ,u'libhashkit Documentation'            ,man_authors,3),
  69   ('libhashkit/hashkit_functions'              ,'hashkit_fnv1_64'                         ,u'libhashkit Documentation'            ,man_authors,3),
  70   ('libhashkit/hashkit_functions'              ,'hashkit_fnv1a_32'                        ,u'libhashkit Documentation'            ,man_authors,3),
  71   ('libhashkit/hashkit_functions'              ,'hashkit_fnv1a_64'                        ,u'libhashkit Documentation'            ,man_authors,3),
  72   ('libhashkit/hashkit_functions'              ,'hashkit_functions'                       ,u'libhashkit Documentation'            ,man_authors,3),
  73   ('libhashkit/hashkit_functions'              ,'hashkit_hsieh'                           ,u'libhashkit Documentation'            ,man_authors,3),
  74   ('libhashkit/hashkit_functions'              ,'hashkit_jenkins'                         ,u'libhashkit Documentation'            ,man_authors,3),
  75   ('libhashkit/hashkit_functions'              ,'hashkit_md5'                             ,u'libhashkit Documentation'            ,man_authors,3),
  76   ('libhashkit/hashkit_functions'              ,'hashkit_murmur'                          ,u'libhashkit Documentation'            ,man_authors,3),
  77   ('libhashkit/hashkit_value'                  ,'hashkit_value'                           ,u'libhashkit Documentation'            ,man_authors,3),
  78
  79   ('libmemcached'                              ,'libmemcached'                            ,u'C/C++ Client Library for memcached'  ,man_authors,3),
  80   ('libmemcached/configuration'                ,'libmemcached_check_configuration'        ,u'libmemcached Documentation'          ,man_authors,3),
  81   ('libmemcached/configuration'                ,'libmemcached_configuration'              ,u'libmemcached Documentation'          ,man_authors,3),
  82   ('libmemcached/configuration'                ,'memcached'                               ,u'libmemcached Documentation'          ,man_authors,3),
  83   ('libmemcached/examples'                     ,'libmemcached_examples'                   ,u'libmemcached Documentation'          ,man_authors,3),
  84   ('libmemcached/memcached_analyze'            ,'memcached_analyze'                       ,u'libmemcached Documentation'          ,man_authors,3),
  85   ('libmemcached/memcached_append'             ,'memcached_append_by_key'                 ,u'Appending to or Prepending Data'     ,man_authors,3),
  86   ('libmemcached/memcached_append'             ,'memcached_append'                        ,u'Appending to or Prepending Data'     ,man_authors,3),
  87   ('libmemcached/memcached_append'             ,'memcached_prepend_by_key'                ,u'Appending to or Prepending Data'     ,man_authors,3),
  88   ('libmemcached/memcached_append'             ,'memcached_prepend'                       ,u'Appending to or Prepending Data'     ,man_authors,3),
  89   ('libmemcached/memcached_auto'               ,'memcached_auto'                          ,u'Incrementing and Decrementing Values',man_authors,3),
  90   ('libmemcached/memcached_auto'               ,'memcached_decrement'                     ,u'Incrementing and Decrementing Values',man_authors,3),
  91   ('libmemcached/memcached_auto'               ,'memcached_decrement_with_initial'        ,u'Incrementing and Decrementing Values',man_authors,3),
  92   ('libmemcached/memcached_auto'               ,'memcached_increment'                     ,u'Incrementing and Decrementing Values',man_authors,3),
  93   ('libmemcached/memcached_auto'               ,'memcached_increment_with_initial'        ,u'Incrementing and Decrementing Values',man_authors,3),
  94   ('libmemcached/memcached_behavior'           ,'memcached_behavior_get'                  ,u'libmemcached Documentation'          ,man_authors,3),
  95   ('libmemcached/memcached_behavior'           ,'memcached_behavior_set'                  ,u'libmemcached Documentation'          ,man_authors,3),
  96   ('libmemcached/memcached_behavior'           ,'memcached_behavior'                      ,u'libmemcached Documentation'          ,man_authors,3),
  97   ('libmemcached/memcached_callback'           ,'memcached_callback_get'                  ,u'libmemcached Documentation'          ,man_authors,3),
  98   ('libmemcached/memcached_callback'           ,'memcached_callback_set'                  ,u'libmemcached Documentation'          ,man_authors,3),
  99   ('libmemcached/memcached_callback'           ,'memcached_callback'                      ,u'libmemcached Documentation'          ,man_authors,3),
 100   ('libmemcached/memcached_cas'                ,'memcached_cas_by_key'                    ,u'Storing and Replacing Data'          ,man_authors,3),
 101   ('libmemcached/memcached_cas'                ,'memcached_cas'                           ,u'Atomic Compare and Swap'             ,man_authors,3),
 102   ('libmemcached/memcached_create'             ,'memcached_clone'                         ,u'libmemcached Documentation'          ,man_authors,3),
 103   ('libmemcached/memcached_create'             ,'memcached_create'                        ,u'libmemcached Documentation'          ,man_authors,3),
 104   ('libmemcached/memcached_create'             ,'memcached_free'                          ,u'libmemcached Documentation'          ,man_authors,3),
 105   ('libmemcached/memcached_create'             ,'memcached_servers_reset'                 ,u'libmemcached Documentation'          ,man_authors,3),
 106   ('libmemcached/memcached_delete'             ,'memcached_delete_by_key'                 ,u'libmemcached Documentation'          ,man_authors,3),
 107   ('libmemcached/memcached_delete'             ,'memcached_delete'                        ,u'libmemcached Documentation'          ,man_authors,3),
 108   ('libmemcached/memcached_dump'               ,'memcached_dump'                          ,u'libmemcached Documentation'          ,man_authors,3),
 109   ('libmemcached/memcached_exist'              ,'memcached_exist_by_key'                  ,u'libmemcached Documentation'          ,man_authors,3),
 110   ('libmemcached/memcached_exist'              ,'memcached_exist'                         ,u'libmemcached Documentation'          ,man_authors,3),
 111   ('libmemcached/memcached_fetch'              ,'memcached_fetch'                         ,u'Retrieving data from the server'     ,man_authors,3),
 112   ('libmemcached/memcached_flush_buffers'      ,'memcached_flush_buffers'                 ,u'libmemcached Documentation'          ,man_authors,3),
 113   ('libmemcached/memcached_flush'              ,'memcached_flush'                         ,u'libmemcached Documentation'          ,man_authors,3),
 114   ('libmemcached/memcached_generate_hash_value','memcached_generate_hash'                 ,u'Generating hash values directly'     ,man_authors,3),
 115   ('libmemcached/memcached_generate_hash_value','memcached_generate_hash_value'           ,u'Generating hash values directly'     ,man_authors,3),
 116   ('libmemcached/memcached_get'                ,'memcached_fetch_execute'                 ,u'Retrieving data from the server'     ,man_authors,3),
 117   ('libmemcached/memcached_get'                ,'memcached_fetch_result'                  ,u'Retrieving data from the server'     ,man_authors,3),
 118   ('libmemcached/memcached_get'                ,'memcached_get_by_key'                    ,u'Retrieving data from the server'     ,man_authors,3),
 119   ('libmemcached/memcached_get'                ,'memcached_get'                           ,u'Retrieving data from the server'     ,man_authors,3),
 120   ('libmemcached/memcached_get'                ,'memcached_mget_by_key'                   ,u'Retrieving data from the server'     ,man_authors,3),
 121   ('libmemcached/memcached_get'                ,'memcached_mget_execute_by_key'           ,u'Retrieving data from the server'     ,man_authors,3),
 122   ('libmemcached/memcached_get'                ,'memcached_mget_execute'                  ,u'Retrieving data from the server'     ,man_authors,3),
 123   ('libmemcached/memcached_get'                ,'memcached_mget'                          ,u'Retrieving data from the server'     ,man_authors,3),
 124   ('libmemcached/memcached_last_error'         ,'memcached_last_error_errno'              ,u'libmemcached Documentation'          ,man_authors,3),
 125   ('libmemcached/memcached_last_error'         ,'memcached_last_error_message'            ,u'libmemcached Documentation'          ,man_authors,3),
 126   ('libmemcached/memcached_last_error'         ,'memcached_last_error'                    ,u'libmemcached Documentation'          ,man_authors,3),
 127   ('libmemcached/memcached_memory_allocators'  ,'memcached_get_memory_allocators'         ,u'libmemcached Documentation'          ,man_authors,3),
 128   ('libmemcached/memcached_memory_allocators'  ,'memcached_memory_allocators'             ,u'libmemcached Documentation'          ,man_authors,3),
 129   ('libmemcached/memcached_memory_allocators'  ,'memcached_set_memory_allocators_context' ,u'libmemcached Documentation'          ,man_authors,3),
 130   ('libmemcached/memcached_memory_allocators'  ,'memcached_set_memory_allocators'         ,u'libmemcached Documentation'          ,man_authors,3),
 131   ('libmemcached/memcached_quit'               ,'memcached_quit'                          ,u'libmemcached Documentation'          ,man_authors,3),
 132   ('libmemcached/memcached_result_st'          ,'memcached_result_cas'                    ,u'Working with result sets'            ,man_authors,3),
 133   ('libmemcached/memcached_result_st'          ,'memcached_result_create'                 ,u'Working with result sets'            ,man_authors,3),
 134   ('libmemcached/memcached_result_st'          ,'memcached_result_flags'                  ,u'Working with result sets'            ,man_authors,3),
 135   ('libmemcached/memcached_result_st'          ,'memcached_result_free'                   ,u'Working with result sets'            ,man_authors,3),
 136   ('libmemcached/memcached_result_st'          ,'memcached_result_key_length'             ,u'Working with result sets'            ,man_authors,3),
 137   ('libmemcached/memcached_result_st'          ,'memcached_result_key_value'              ,u'Working with result sets'            ,man_authors,3),
 138   ('libmemcached/memcached_result_st'          ,'memcached_result_length'                 ,u'Working with result sets'            ,man_authors,3),
 139   ('libmemcached/memcached_result_st'          ,'memcached_result_st'                     ,u'Working with result sets'            ,man_authors,3),
 140   ('libmemcached/memcached_result_st'          ,'memcached_result_value'                  ,u'Working with result sets'            ,man_authors,3),
 141   ('libmemcached/memcached_return_t'           ,'memcached_return_t'                      ,u'Return type values '                 ,man_authors,3),
 142   ('libmemcached/memcached_sasl'               ,'memcached_destroy_sasl_auth_data'        ,u'libmemcached Documentation'          ,man_authors,3),
 143   ('libmemcached/memcached_sasl'               ,'memcached_get_sasl_callbacks'            ,u'libmemcached Documentation'          ,man_authors,3),
 144   ('libmemcached/memcached_sasl'               ,'memcached_sasl_set_auth_data'            ,u'libmemcached Documentation'          ,man_authors,3),
 145   ('libmemcached/memcached_sasl'               ,'memcached_sasl'                          ,u'libmemcached Documentation'          ,man_authors,3),
 146   ('libmemcached/memcached_sasl'               ,'memcached_set_sasl_callbacks'            ,u'libmemcached Documentation'          ,man_authors,3),
 147   ('libmemcached/memcached_servers'            ,'memcached_server_add'                    ,u'libmemcached Documentation'          ,man_authors,3),
 148   ('libmemcached/memcached_servers'            ,'memcached_server_add_unix_socket'        ,u'libmemcached Documentation'          ,man_authors,3),
 149   ('libmemcached/memcached_servers'            ,'memcached_server_count'                  ,u'libmemcached Documentation'          ,man_authors,3),
 150   ('libmemcached/memcached_servers'            ,'memcached_server_cursor'                 ,u'libmemcached Documentation'          ,man_authors,3),
 151   ('libmemcached/memcached_servers'            ,'memcached_server_list'                   ,u'libmemcached Documentation'          ,man_authors,3),
 152   ('libmemcached/memcached_servers'            ,'memcached_server_push'                   ,u'libmemcached Documentation'          ,man_authors,3),
 153   ('libmemcached/memcached_servers'            ,'memcached_server_st'                     ,u'libmemcached Documentation'          ,man_authors,3),
 154   ('libmemcached/memcached_servers'            ,'memcached_servers'                       ,u'libmemcached Documentation'          ,man_authors,3),
 155   ('libmemcached/memcached_server_st'          ,'memcached_server_list_append'            ,u'libmemcached Documentation'          ,man_authors,3),
 156   ('libmemcached/memcached_server_st'          ,'memcached_server_list_count'             ,u'libmemcached Documentation'          ,man_authors,3),
 157   ('libmemcached/memcached_server_st'          ,'memcached_server_list_free'              ,u'libmemcached Documentation'          ,man_authors,3),
 158   ('libmemcached/memcached_server_st'          ,'memcached_servers_parse'                 ,u'libmemcached Documentation'          ,man_authors,3),
 159   ('libmemcached/memcached_set_encoding_key'   ,'memcached_set_encoding_key'              ,u'libmemcached Documentation'          ,man_authors,3),
 160   ('libmemcached/memcached_set'                ,'memcached_add_by_key'                    ,u'Storing and Replacing Data'          ,man_authors,3),
 161   ('libmemcached/memcached_set'                ,'memcached_add'                           ,u'Storing and Replacing Data'          ,man_authors,3),
 162   ('libmemcached/memcached_set'                ,'memcached_replace_by_key'                ,u'Storing and Replacing Data'          ,man_authors,3),
 163   ('libmemcached/memcached_set'                ,'memcached_replace'                       ,u'Storing and Replacing Data'          ,man_authors,3),
 164   ('libmemcached/memcached_set'                ,'memcached_set_by_key'                    ,u'Storing and Replacing Data'          ,man_authors,3),
 165   ('libmemcached/memcached_set'                ,'memcached_set'                           ,u'Storing and Replacing Data'          ,man_authors,3),
 166   ('libmemcached/memcached_stats'              ,'memcached_stat_execute'                  ,u'libmemcached Documentation'          ,man_authors,3),
 167   ('libmemcached/memcached_stats'              ,'memcached_stat_get_keys'                 ,u'libmemcached Documentation'          ,man_authors,3),
 168   ('libmemcached/memcached_stats'              ,'memcached_stat_get_value'                ,u'libmemcached Documentation'          ,man_authors,3),
 169   ('libmemcached/memcached_stats'              ,'memcached_stat_servername'               ,u'libmemcached Documentation'          ,man_authors,3),
 170   ('libmemcached/memcached_stats'              ,'memcached_stats'                         ,u'libmemcached Documentation'          ,man_authors,3),
 171   ('libmemcached/memcached_stats'              ,'memcached_stat'                          ,u'libmemcached Documentation'          ,man_authors,3),
 172   ('libmemcached/memcached_strerror'           ,'memcached_strerror'                      ,u'libmemcached Documentation'          ,man_authors,3),
 173   ('libmemcached/memcached_touch'              ,'memcached_touch_by_key'                  ,u'libmemcached Documentation'          ,man_authors,3),
 174   ('libmemcached/memcached_touch'              ,'memcached_touch'                         ,u'libmemcached Documentation'          ,man_authors,3),
 175   ('libmemcached/memcached_user_data'          ,'memcached_get_user_data'                 ,u'libmemcached Documentation'          ,man_authors,3),
 176   ('libmemcached/memcached_user_data'          ,'memcached_set_user_data'                 ,u'libmemcached Documentation'          ,man_authors,3),
 177   ('libmemcached/memcached_user_data'          ,'memcached_user_data'                     ,u'libmemcached Documentation'          ,man_authors,3),
 178   ('libmemcached/memcached_verbosity'          ,'memcached_verbosity'                     ,u'libmemcached Documentation'          ,man_authors,3),
 179   ('libmemcached/memcached_version'            ,'memcached_lib_version'                   ,u'libmemcached Documentation'          ,man_authors,3),
 180   ('libmemcached/memcached_version'            ,'memcached_version'                       ,u'libmemcached Documentation'          ,man_authors,3),
 181
 182   ('libmemcachedutil/index'                    ,'libmemcachedutil'                        ,u'libmemcached Documentation'          ,man_authors,3),
 183   ('libmemcachedutil/memcached_pool'           ,'memcached_pool_behavior_get'             ,u'libmemcached Documentation'          ,man_authors,3),
 184   ('libmemcachedutil/memcached_pool'           ,'memcached_pool_behavior_set'             ,u'libmemcached Documentation'          ,man_authors,3),
 185   ('libmemcachedutil/memcached_pool'           ,'memcached_pool_create'                   ,u'libmemcached Documentation'          ,man_authors,3),
 186   ('libmemcachedutil/memcached_pool'           ,'memcached_pool_destroy'                  ,u'libmemcached Documentation'          ,man_authors,3),
 187   ('libmemcachedutil/memcached_pool'           ,'memcached_pool_fetch'                    ,u'libmemcached Documentation'          ,man_authors,3),
 188   ('libmemcachedutil/memcached_pool'           ,'memcached_pool_pop'                      ,u'libmemcached Documentation'          ,man_authors,3),
 189   ('libmemcachedutil/memcached_pool'           ,'memcached_pool_push'                     ,u'libmemcached Documentation'          ,man_authors,3),
 190   ('libmemcachedutil/memcached_pool'           ,'memcached_pool_release'                  ,u'libmemcached Documentation'          ,man_authors,3),
 191   ('libmemcachedutil/memcached_pool'           ,'memcached_pool_st'                       ,u'libmemcached Documentation'          ,man_authors,3),
 192   ('libmemcachedutil/memcached_pool'           ,'memcached_pool'                          ,u'libmemcached Documentation'          ,man_authors,3),
 193
 194   ('bin/memcapable'                            , 'memcapable'                             , u'libmemcached Documentation'         , man_authors, 1),
 195   ('bin/memcat'                                , 'memcat'                                 , u'libmemcached Documentation'         , man_authors, 1),
 196   ('bin/memcp'                                 , 'memcp'                                  , u'libmemcached Documentation'         , man_authors, 1),
 197   ('bin/memdump'                               , 'memdump'                                , u'libmemcached Documentation'         , man_authors, 1),
 198   ('bin/memerror'                              , 'memerror'                               , u'libmemcached Documentation'         , man_authors, 1),
 199   ('bin/memflush'                              , 'memflush'                               , u'libmemcached Documentation'         , man_authors, 1),
 200   ('bin/memrm'                                 , 'memrm'                                  , u'libmemcached Documentation'         , man_authors, 1),
 201   ('bin/memaslap'                              , 'memaslap'                               , u'libmemcached Documentation'         , man_authors, 1),
 202   ('bin/memslap'                               , 'memslap'                                , u'libmemcached Documentation'         , man_authors, 1),
 203   ('bin/memstat'                               , 'memstat'                                , u'libmemcached Documentation'         , man_authors, 1),
 204   ('bin/memexist'                              , 'memexist'                               , u'libmemcached Documentation'         , man_authors, 1),
 205   ('bin/memparse'                              , 'memparse'                               , u'libmemcached Documentation'         , man_authors, 1),
 206   ('bin/memping'                               , 'memping'                                , u'libmemcached Documentation'         , man_authors, 1),
 207   ('bin/memtouch'                              , 'memtouch'                               , u'libmemcached Documentation'         , man_authors, 1),
 208   ]
 209
 210 rst_prolog = """
 211 .. |libhashkit_version| replace:: @LIBHASHKIT_VERSION_MAJOR@
 212 .. |libmemcached_version| replace:: @LIBMEMCACHED_VERSION_MAJOR@
 213 .. |libmemcachedprotocol_version| replace:: @LIBMEMCACHEDPROTOCOL_VERSION_MAJOR@
 214 .. |libmemcachedutil_version| replace:: @LIBMEMCACHEDUTIL_VERSION_MAJOR@
 215 """
 216
 217 @SPHINX_CONF_APPEND@