From c2805aebdc58795ca599755627789f59a4ce60aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Grisez?= Date: Thu, 5 Apr 2018 11:31:44 +0200 Subject: [PATCH] [doc] Gathers all guiding page inside a directory --- coreapi/help/doc/sphinx/CMakeLists.txt | 33 ++++++++++--------- .../sphinx/{ => guides}/authentication.rst | 0 .../doc/sphinx/{ => guides}/buddy_list.rst | 0 .../doc/sphinx/{ => guides}/call_control.rst | 0 .../doc/sphinx/{ => guides}/call_logs.rst | 0 .../doc/sphinx/{ => guides}/call_misc.rst | 0 .../help/doc/sphinx/{ => guides}/chatroom.rst | 0 .../doc/sphinx/{ => guides}/conferencing.rst | 0 .../doc/sphinx/{ => guides}/event_api.rst | 0 .../doc/sphinx/{ => guides}/initializing.rst | 0 .../sphinx/{ => guides}/ios_portability.rst | 0 .../sphinx/{ => guides}/linphone_address.rst | 0 .../sphinx/{ => guides}/media_parameters.rst | 0 coreapi/help/doc/sphinx/{ => guides}/misc.rst | 0 .../{ => guides}/network_parameters.rst | 0 .../help/doc/sphinx/{ => guides}/proxies.rst | 0 coreapi/help/doc/sphinx/index.rst | 30 ++++++++--------- 17 files changed, 32 insertions(+), 31 deletions(-) rename coreapi/help/doc/sphinx/{ => guides}/authentication.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/buddy_list.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/call_control.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/call_logs.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/call_misc.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/chatroom.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/conferencing.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/event_api.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/initializing.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/ios_portability.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/linphone_address.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/media_parameters.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/misc.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/network_parameters.rst (100%) rename coreapi/help/doc/sphinx/{ => guides}/proxies.rst (100%) diff --git a/coreapi/help/doc/sphinx/CMakeLists.txt b/coreapi/help/doc/sphinx/CMakeLists.txt index ba42f25b5..df0cee4e7 100644 --- a/coreapi/help/doc/sphinx/CMakeLists.txt +++ b/coreapi/help/doc/sphinx/CMakeLists.txt @@ -39,28 +39,29 @@ if (ENABLE_SPHINX_DOC) enum_page.mustache index_page.mustache ) - set(STATIC_DOCUMENTATION_FILES authentication.rst - buddy_list.rst - call_control.rst - call_logs.rst - call_misc.rst - chatroom.rst - conferencing.rst - event_api.rst + set(STATIC_DOCUMENTATION_FILES + guides/authentication.rst + guides/buddy_list.rst + guides/call_control.rst + guides/call_logs.rst + guides/call_misc.rst + guides/chatroom.rst + guides/conferencing.rst + guides/event_api.rst + guides/initializing.rst + guides/ios_portability.rst + guides/linphone_address.rst + guides/media_parameters.rst + guides/misc.rst + guides/network_parameters.rst + guides/proxies.rst index.rst - initializing.rst - ios_portability.rst - linphone_address.rst logo.png - media_parameters.rst - misc.rst - network_parameters.rst - proxies.rst toc.rst ) configure_file(conf.py.in source/conf.py) foreach(file ${STATIC_DOCUMENTATION_FILES}) - configure_file(${file} source/${files} COPYONLY) + configure_file(${file} source/${file} COPYONLY) endforeach(file) add_custom_target(sphinx-doc ALL ${PYTHON_EXECUTABLE} '${CMAKE_CURRENT_SOURCE_DIR}/gendoc.py' '${LINPHONE_DOXYGEN_XML_DIR}' -o 'source' COMMAND ${PYTHON_EXECUTABLE} -msphinx -M html 'source' 'build' diff --git a/coreapi/help/doc/sphinx/authentication.rst b/coreapi/help/doc/sphinx/guides/authentication.rst similarity index 100% rename from coreapi/help/doc/sphinx/authentication.rst rename to coreapi/help/doc/sphinx/guides/authentication.rst diff --git a/coreapi/help/doc/sphinx/buddy_list.rst b/coreapi/help/doc/sphinx/guides/buddy_list.rst similarity index 100% rename from coreapi/help/doc/sphinx/buddy_list.rst rename to coreapi/help/doc/sphinx/guides/buddy_list.rst diff --git a/coreapi/help/doc/sphinx/call_control.rst b/coreapi/help/doc/sphinx/guides/call_control.rst similarity index 100% rename from coreapi/help/doc/sphinx/call_control.rst rename to coreapi/help/doc/sphinx/guides/call_control.rst diff --git a/coreapi/help/doc/sphinx/call_logs.rst b/coreapi/help/doc/sphinx/guides/call_logs.rst similarity index 100% rename from coreapi/help/doc/sphinx/call_logs.rst rename to coreapi/help/doc/sphinx/guides/call_logs.rst diff --git a/coreapi/help/doc/sphinx/call_misc.rst b/coreapi/help/doc/sphinx/guides/call_misc.rst similarity index 100% rename from coreapi/help/doc/sphinx/call_misc.rst rename to coreapi/help/doc/sphinx/guides/call_misc.rst diff --git a/coreapi/help/doc/sphinx/chatroom.rst b/coreapi/help/doc/sphinx/guides/chatroom.rst similarity index 100% rename from coreapi/help/doc/sphinx/chatroom.rst rename to coreapi/help/doc/sphinx/guides/chatroom.rst diff --git a/coreapi/help/doc/sphinx/conferencing.rst b/coreapi/help/doc/sphinx/guides/conferencing.rst similarity index 100% rename from coreapi/help/doc/sphinx/conferencing.rst rename to coreapi/help/doc/sphinx/guides/conferencing.rst diff --git a/coreapi/help/doc/sphinx/event_api.rst b/coreapi/help/doc/sphinx/guides/event_api.rst similarity index 100% rename from coreapi/help/doc/sphinx/event_api.rst rename to coreapi/help/doc/sphinx/guides/event_api.rst diff --git a/coreapi/help/doc/sphinx/initializing.rst b/coreapi/help/doc/sphinx/guides/initializing.rst similarity index 100% rename from coreapi/help/doc/sphinx/initializing.rst rename to coreapi/help/doc/sphinx/guides/initializing.rst diff --git a/coreapi/help/doc/sphinx/ios_portability.rst b/coreapi/help/doc/sphinx/guides/ios_portability.rst similarity index 100% rename from coreapi/help/doc/sphinx/ios_portability.rst rename to coreapi/help/doc/sphinx/guides/ios_portability.rst diff --git a/coreapi/help/doc/sphinx/linphone_address.rst b/coreapi/help/doc/sphinx/guides/linphone_address.rst similarity index 100% rename from coreapi/help/doc/sphinx/linphone_address.rst rename to coreapi/help/doc/sphinx/guides/linphone_address.rst diff --git a/coreapi/help/doc/sphinx/media_parameters.rst b/coreapi/help/doc/sphinx/guides/media_parameters.rst similarity index 100% rename from coreapi/help/doc/sphinx/media_parameters.rst rename to coreapi/help/doc/sphinx/guides/media_parameters.rst diff --git a/coreapi/help/doc/sphinx/misc.rst b/coreapi/help/doc/sphinx/guides/misc.rst similarity index 100% rename from coreapi/help/doc/sphinx/misc.rst rename to coreapi/help/doc/sphinx/guides/misc.rst diff --git a/coreapi/help/doc/sphinx/network_parameters.rst b/coreapi/help/doc/sphinx/guides/network_parameters.rst similarity index 100% rename from coreapi/help/doc/sphinx/network_parameters.rst rename to coreapi/help/doc/sphinx/guides/network_parameters.rst diff --git a/coreapi/help/doc/sphinx/proxies.rst b/coreapi/help/doc/sphinx/guides/proxies.rst similarity index 100% rename from coreapi/help/doc/sphinx/proxies.rst rename to coreapi/help/doc/sphinx/guides/proxies.rst diff --git a/coreapi/help/doc/sphinx/index.rst b/coreapi/help/doc/sphinx/index.rst index 24fa3502f..c036cd442 100644 --- a/coreapi/help/doc/sphinx/index.rst +++ b/coreapi/help/doc/sphinx/index.rst @@ -32,21 +32,21 @@ Beginners' guides .. toctree:: :maxdepth: 1 - initializing - call_control - call_misc - media_parameters - proxies - network_parameters - authentication - buddy_list - chatroom - call_logs - linphone_address - conferencing - event_api - misc - ios_portability + guides/initializing + guides/call_control + guides/call_misc + guides/media_parameters + guides/proxies + guides/network_parameters + guides/authentication + guides/buddy_list + guides/chatroom + guides/call_logs + guides/linphone_address + guides/conferencing + guides/event_api + guides/misc + guides/ios_portability Code samples