├── .gitignore ├── .idea ├── .gitignore ├── OpenProfinet.iml ├── inspectionProfiles │ └── Project_Default.xml ├── misc.xml ├── modules.xml └── vcs.xml ├── CMakeLists.txt ├── LICENSE ├── README.md ├── cmake └── FindSphinx.cmake ├── docs-src ├── CMakeLists.txt ├── Doxyfile.in ├── conf.py └── index.rst ├── docs ├── .buildinfo ├── .doctrees │ ├── environment.pickle │ └── index.doctree ├── .nojekyll ├── _sources │ └── index.rst.txt ├── _static │ ├── basic.css │ ├── css │ │ ├── custom.css │ │ ├── theme.css │ │ └── theme.min.css │ ├── doctools.js │ ├── documentation_options.js │ ├── file.png │ ├── font │ │ ├── fontello.eot │ │ ├── fontello.svg │ │ ├── fontello.ttf │ │ ├── fontello.woff │ │ └── fontello.woff2 │ ├── jquery-3.5.1.js │ ├── jquery.js │ ├── js │ │ └── theme.js │ ├── language_data.js │ ├── minus.png │ ├── plus.png │ ├── pygments.css │ ├── searchtools.js │ ├── underscore-1.12.0.js │ └── underscore.js ├── genindex.html ├── index.html ├── objects.inv ├── search.html └── searchindex.js ├── include └── CLI11.hpp └── src ├── ProfinetTool.cpp ├── ProfinetTool.h ├── main.cpp ├── pcapInterface.c ├── pcapInterface.h └── profinetTypes.h /.gitignore: -------------------------------------------------------------------------------- 1 | CMakeLists.txt.user 2 | CMakeCache.txt 3 | CMakeFiles 4 | CMakeScripts 5 | Testing 6 | Makefile 7 | cmake_install.cmake 8 | install_manifest.txt 9 | compile_commands.json 10 | CTestTestfile.cmake 11 | _deps 12 | .idea/**/workspace.xml 13 | .idea/**/tasks.xml 14 | .idea/**/usage.statistics.xml 15 | .idea/**/dictionaries 16 | .idea/**/shelf 17 | .idea/**/contentModel.xml 18 | .idea/**/dataSources/ 19 | .idea/**/dataSources.ids 20 | .idea/**/dataSources.local.xml 21 | .idea/**/sqlDataSources.xml 22 | .idea/**/dynamic.xml 23 | .idea/**/uiDesigner.xml 24 | .idea/**/dbnavigator.xml 25 | .idea/**/gradle.xml 26 | .idea/**/libraries 27 | cmake-build-*/ 28 | .idea/**/mongoSettings.xml 29 | *.iws 30 | out/ 31 | .idea_modules/ 32 | atlassian-ide-plugin.xml 33 | .idea/replstate.xml 34 | com_crashlytics_export_strings.xml 35 | crashlytics.properties 36 | crashlytics-build.properties 37 | fabric.properties 38 | .idea/httpRequests 39 | .idea/caches/build_file_checksums.ser 40 | *.d 41 | *.slo 42 | *.lo 43 | *.o 44 | *.obj 45 | *.gch 46 | *.pch 47 | *.so 48 | *.dylib 49 | *.dll 50 | *.mod 51 | *.smod 52 | *.lai 53 | *.la 54 | *.a 55 | *.lib 56 | *.exe 57 | *.out 58 | *.app 59 | *.ko 60 | *.elf 61 | *.ilk 62 | *.map 63 | *.exp 64 | *.so.* 65 | *.i*86 66 | *.x86_64 67 | *.hex 68 | *.dSYM/ 69 | *.su 70 | *.idb 71 | *.pdb 72 | *.mod* 73 | *.cmd 74 | .tmp_versions/ 75 | modules.order 76 | Module.symvers 77 | Mkfile.old 78 | dkms.conf 79 | -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | # Datasource local storage ignored files 5 | /dataSources/ 6 | /dataSources.local.xml 7 | # Editor-based HTTP Client requests 8 | /httpRequests/ 9 | -------------------------------------------------------------------------------- /.idea/OpenProfinet.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/inspectionProfiles/Project_Default.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 12 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | project(OpenProfinet) 3 | set(CMAKE_PROJECT_VERSION_MAJOR 0) 4 | set(CMAKE_PROJECT_VERSION_MINOR 9) 5 | set(CMAKE_PROJECT_VERSION_PATCH 3) 6 | 7 | set(CMAKE_CXX_STANDARD 20) 8 | 9 | find_package(Threads REQUIRED) 10 | 11 | include_directories(include) 12 | 13 | add_executable(pntool src/main.cpp src/pcapInterface.c src/ProfinetTool.cpp) 14 | 15 | target_link_libraries(pntool pcap Threads::Threads) 16 | 17 | install(TARGETS pntool DESTINATION bin) 18 | 19 | set(CPACK_GENERATOR DEB) 20 | set(CPACK_DEBIAN_PACKAGE_NAME OpenProfinet) 21 | set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Nareshkumar Rao ") 22 | set(CPACK_DEBIAN_PACKAGE_DEPENDS "libpcap0.8-dev") 23 | set(CPACK_DEBIAN_PACKAGE_DESCRIPTION " 24 | OpenProfinet is a collection of tools for working with Profinet on Linux 25 | https://github.com/naresh97/OpenProfinet 26 | ") 27 | set(CPACK_DEBIAN_FILE_NAME OpenProfinet-${CMAKE_PROJECT_VERSION_MAJOR}.${CMAKE_PROJECT_VERSION_MINOR}.${CMAKE_PROJECT_VERSION_PATCH}.deb) 28 | include(CPack) 29 | 30 | set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH}) 31 | 32 | add_subdirectory(docs-src) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OpenProfinet 2 | 3 | A collection of tools for configuring Profinet devices on Linux based systems. 4 | Uses libpcap library for creating Ethernet frames. 5 | 6 | [View OpenProfinet Documentation on Github Pages](https://naresh97.github.io/OpenProfinet/) 7 | 8 | ## Usage: pntool 9 | 10 | ### pntool search 11 | ``` 12 | Search for Profinet devices on the network. 13 | Usage: pntool search [OPTIONS] 14 | 15 | Options: 16 | -h,--help Print this help message and exit 17 | -i,--interface Interface to use 18 | -t,--timeout INT Time to search for devices in milliseconds 19 | 20 | ``` 21 | 22 | ### pntool configure 23 | ``` 24 | Configure Profinet devices on the network. 25 | Usage: pntool configure [OPTIONS] device 26 | 27 | Positionals: 28 | device REQUIRED The current name of the device to configure 29 | 30 | Options: 31 | -h,--help Print this help message and exit 32 | -t,--timeout INT Time to search for devices in milliseconds 33 | -n,--name TEXT Set a new name for the device 34 | -i,--ip TEXT New IP Address 35 | -s,--subnet TEXT New Subnet Mask 36 | -g,--gateway TEXT New Gateway Address 37 | 38 | ``` 39 | 40 | ## Building 41 | 42 | Uses CMake as build system. 43 | 44 | ```bash 45 | mkdir ./build 46 | cd ./build 47 | cmake .. 48 | make 49 | ``` 50 | 51 | ## Licensing 52 | 53 | This software is open-source and free to use as specified in the GPLv3 license for **non-commercial** use only. 54 | Permission for commercial use require explicit permission of the author. 55 | -------------------------------------------------------------------------------- /cmake/FindSphinx.cmake: -------------------------------------------------------------------------------- 1 | #Look for an executable called sphinx-build 2 | find_program(SPHINX_EXECUTABLE 3 | NAMES sphinx-build 4 | DOC "Path to sphinx-build executable") 5 | 6 | include(FindPackageHandleStandardArgs) 7 | 8 | #Handle standard arguments to find_package like REQUIRED and QUIET 9 | find_package_handle_standard_args(Sphinx 10 | "Failed to find sphinx-build executable" 11 | SPHINX_EXECUTABLE) 12 | -------------------------------------------------------------------------------- /docs-src/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | find_package(Doxygen REQUIRED) 2 | 3 | # Find all the public headers 4 | get_target_property(PNTOOL_PUBLIC_HEADER_DIR pntool INTERFACE_INCLUDE_DIRECTORIES) 5 | file(GLOB_RECURSE PNTOOL_PUBLIC_HEADERS ${PNTOOL_PUBLIC_HEADER_DIR}/*.h) 6 | 7 | set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/src) 8 | set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen) 9 | set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/html/index.html) 10 | set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) 11 | set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) 12 | 13 | #Replace variables inside @@ with the current values 14 | configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY) 15 | 16 | file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}) #Doxygen won't create this for us 17 | 18 | add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE} 19 | DEPENDS ${CAT_CUTIFIER_PUBLIC_HEADERS} 20 | COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT} 21 | MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN} 22 | COMMENT "Generating docs") 23 | 24 | add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE}) 25 | 26 | find_package(Sphinx REQUIRED) 27 | 28 | set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}) 29 | set(SPHINX_BUILD ${PROJECT_SOURCE_DIR}/docs) 30 | 31 | add_custom_target(Sphinx ALL 32 | COMMAND ${SPHINX_EXECUTABLE} -b html 33 | # Tell Breathe where to find the Doxygen output 34 | -Dbreathe_projects.OpenProfinet=${DOXYGEN_OUTPUT_DIR}/xml 35 | ${SPHINX_SOURCE} ${SPHINX_BUILD} 36 | WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} 37 | COMMENT "Generating documentation with Sphinx") -------------------------------------------------------------------------------- /docs-src/conf.py: -------------------------------------------------------------------------------- 1 | # Configuration file for the Sphinx documentation builder. 2 | # 3 | # This file only contains a selection of the most common options. For a full 4 | # list see the documentation: 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html 6 | 7 | # -- Path setup -------------------------------------------------------------- 8 | 9 | # If extensions (or modules to document with autodoc) are in another directory, 10 | # add these directories to sys.path here. If the directory is relative to the 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. 12 | # 13 | # import os 14 | # import sys 15 | # sys.path.insert(0, os.path.abspath('.')) 16 | 17 | 18 | # -- Project information ----------------------------------------------------- 19 | 20 | project = 'OpenProfinet' 21 | copyright = '2021, Nareshkumar Rao' 22 | author = 'Nareshkumar Rao' 23 | 24 | # The full version, including alpha/beta/rc tags 25 | release = 'v0.9.2' 26 | 27 | 28 | # -- General configuration --------------------------------------------------- 29 | 30 | # Add any Sphinx extension module names here, as strings. They can be 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 32 | # ones. 33 | extensions = [ 34 | "breathe" 35 | ] 36 | 37 | breathe_default_project = "OpenProfinet" 38 | 39 | # Add any paths that contain templates here, relative to this directory. 40 | templates_path = ['_templates'] 41 | 42 | # List of patterns, relative to source directory, that match files and 43 | # directories to ignore when looking for source files. 44 | # This pattern also affects html_static_path and html_extra_path. 45 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 46 | 47 | 48 | # -- Options for HTML output ------------------------------------------------- 49 | 50 | # The theme to use for HTML and HTML Help pages. See the documentation for 51 | # a list of builtin themes. 52 | # 53 | html_theme = 'karma_sphinx_theme' 54 | 55 | # Add any paths that contain custom static files (such as style sheets) here, 56 | # relative to this directory. They are copied after the builtin static files, 57 | # so a file named "default.css" will overwrite the builtin "default.css". 58 | html_static_path = ['_static'] -------------------------------------------------------------------------------- /docs-src/index.rst: -------------------------------------------------------------------------------- 1 | .. OpenProfinet documentation master file, created by 2 | sphinx-quickstart on Wed Nov 3 17:59:48 2021. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | OpenProfinet 7 | ============= 8 | 9 | .. toctree:: 10 | :maxdepth: 2 11 | :caption: Contents: 12 | 13 | 14 | 15 | Installing 16 | ========== 17 | 18 | The latest releases can be obtained on the `GitHub repository `_ and installed as follows. 19 | 20 | .. code-blocK:: console 21 | 22 | $ sudo apt install ./OpenProfinet-0.9.2-x86_64.deb 23 | 24 | Building 25 | -------- 26 | 27 | OpenProfinet is built using CMake. Simply pull the repository, and run CMake in the standard way. 28 | 29 | .. code-block:: console 30 | 31 | $ git clone https://github.com/naresh97/OpenProfinet.git && cd ./OpenProfinet 32 | $ mkdir ./build && cd ./build 33 | $ cmake .. 34 | $ make 35 | 36 | Pre-requisites 37 | ^^^^^^^^^^^^^^ 38 | 39 | The following pre-requisites are required for building. Ubuntu/Debian packages are specified, but packages on other 40 | distributions should be installed in a similar way. Refer to your distribution's package manager. 41 | 42 | .. code-block:: console 43 | 44 | $ sudo apt install libpcap-dev 45 | 46 | Documentation 47 | ================== 48 | 49 | ProfinetTool 50 | ------------ 51 | 52 | The ProfinetTool class provides a library of tools required for 53 | 54 | .. doxygenclass:: ProfinetTool 55 | :members: 56 | 57 | ProfinetDevice 58 | -------------- 59 | 60 | .. doxygenstruct:: ProfinetDevice 61 | :members: 62 | :private-members: 63 | :undoc-members: 64 | 65 | 66 | PCAP Interface 67 | -------------- 68 | 69 | The PCAP Interface specified in pcapInterface.h provides the a C-based interface to the libpcap library. 70 | Here, we listen, build and send packets to a specified interface, as well as process incoming packets on the 71 | byte level. 72 | 73 | .. doxygenfile:: pcapInterface.h 74 | 75 | Licensing 76 | ========= 77 | 78 | The source code and binaries of this project use the GPLv3 license for **non-commercial** uses only! 79 | 80 | If you would like to use any part of the OpenProfinet project for commercial purposes, you must obtain 81 | explicit permission from the `author `_. 82 | 83 | Indices and tables 84 | ================== 85 | 86 | * :ref:`genindex` 87 | * :ref:`search` 88 | -------------------------------------------------------------------------------- /docs/.buildinfo: -------------------------------------------------------------------------------- 1 | # Sphinx build info version 1 2 | # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. 3 | config: ccb0186b4e2a71897ea41e4a4ab5f5aa 4 | tags: 645f666f9bcd5a90fca523b33c5a78b7 5 | -------------------------------------------------------------------------------- /docs/.doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/.doctrees/environment.pickle -------------------------------------------------------------------------------- /docs/.doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/.doctrees/index.doctree -------------------------------------------------------------------------------- /docs/.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/.nojekyll -------------------------------------------------------------------------------- /docs/_sources/index.rst.txt: -------------------------------------------------------------------------------- 1 | .. OpenProfinet documentation master file, created by 2 | sphinx-quickstart on Wed Nov 3 17:59:48 2021. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | OpenProfinet 7 | ============= 8 | 9 | .. toctree:: 10 | :maxdepth: 2 11 | :caption: Contents: 12 | 13 | 14 | 15 | Installing 16 | ========== 17 | 18 | The latest releases can be obtained on the `GitHub repository `_ and installed as follows. 19 | 20 | .. code-blocK:: console 21 | 22 | $ sudo apt install ./OpenProfinet-0.9.2-x86_64.deb 23 | 24 | Building 25 | -------- 26 | 27 | OpenProfinet is built using CMake. Simply pull the repository, and run CMake in the standard way. 28 | 29 | .. code-block:: console 30 | 31 | $ git clone https://github.com/naresh97/OpenProfinet.git && cd ./OpenProfinet 32 | $ mkdir ./build && cd ./build 33 | $ cmake .. 34 | $ make 35 | 36 | Pre-requisites 37 | ^^^^^^^^^^^^^^ 38 | 39 | The following pre-requisites are required for building. Ubuntu/Debian packages are specified, but packages on other 40 | distributions should be installed in a similar way. Refer to your distribution's package manager. 41 | 42 | .. code-block:: console 43 | 44 | $ sudo apt install libpcap-dev 45 | 46 | Documentation 47 | ================== 48 | 49 | ProfinetTool 50 | ------------ 51 | 52 | The ProfinetTool class provides a library of tools required for 53 | 54 | .. doxygenclass:: ProfinetTool 55 | :members: 56 | 57 | ProfinetDevice 58 | -------------- 59 | 60 | .. doxygenstruct:: ProfinetDevice 61 | :members: 62 | :private-members: 63 | :undoc-members: 64 | 65 | 66 | PCAP Interface 67 | -------------- 68 | 69 | The PCAP Interface specified in pcapInterface.h provides the a C-based interface to the libpcap library. 70 | Here, we listen, build and send packets to a specified interface, as well as process incoming packets on the 71 | byte level. 72 | 73 | .. doxygenfile:: pcapInterface.h 74 | 75 | Licensing 76 | ========= 77 | 78 | The source code and binaries of this project use the GPLv3 license for **non-commercial** uses only! 79 | 80 | If you would like to use any part of the OpenProfinet project for commercial purposes, you must obtain 81 | explicit permission from the `author `_. 82 | 83 | Indices and tables 84 | ================== 85 | 86 | * :ref:`genindex` 87 | * :ref:`search` 88 | -------------------------------------------------------------------------------- /docs/_static/basic.css: -------------------------------------------------------------------------------- 1 | /* 2 | * basic.css 3 | * ~~~~~~~~~ 4 | * 5 | * Sphinx stylesheet -- basic theme. 6 | * 7 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | /* -- main layout ----------------------------------------------------------- */ 13 | 14 | div.clearer { 15 | clear: both; 16 | } 17 | 18 | div.section::after { 19 | display: block; 20 | content: ''; 21 | clear: left; 22 | } 23 | 24 | /* -- relbar ---------------------------------------------------------------- */ 25 | 26 | div.related { 27 | width: 100%; 28 | font-size: 90%; 29 | } 30 | 31 | div.related h3 { 32 | display: none; 33 | } 34 | 35 | div.related ul { 36 | margin: 0; 37 | padding: 0 0 0 10px; 38 | list-style: none; 39 | } 40 | 41 | div.related li { 42 | display: inline; 43 | } 44 | 45 | div.related li.right { 46 | float: right; 47 | margin-right: 5px; 48 | } 49 | 50 | /* -- sidebar --------------------------------------------------------------- */ 51 | 52 | div.sphinxsidebarwrapper { 53 | padding: 10px 5px 0 10px; 54 | } 55 | 56 | div.sphinxsidebar { 57 | float: left; 58 | width: 230px; 59 | margin-left: -100%; 60 | font-size: 90%; 61 | word-wrap: break-word; 62 | overflow-wrap : break-word; 63 | } 64 | 65 | div.sphinxsidebar ul { 66 | list-style: none; 67 | } 68 | 69 | div.sphinxsidebar ul ul, 70 | div.sphinxsidebar ul.want-points { 71 | margin-left: 20px; 72 | list-style: square; 73 | } 74 | 75 | div.sphinxsidebar ul ul { 76 | margin-top: 0; 77 | margin-bottom: 0; 78 | } 79 | 80 | div.sphinxsidebar form { 81 | margin-top: 10px; 82 | } 83 | 84 | div.sphinxsidebar input { 85 | border: 1px solid #98dbcc; 86 | font-family: sans-serif; 87 | font-size: 1em; 88 | } 89 | 90 | div.sphinxsidebar #searchbox form.search { 91 | overflow: hidden; 92 | } 93 | 94 | div.sphinxsidebar #searchbox input[type="text"] { 95 | float: left; 96 | width: 80%; 97 | padding: 0.25em; 98 | box-sizing: border-box; 99 | } 100 | 101 | div.sphinxsidebar #searchbox input[type="submit"] { 102 | float: left; 103 | width: 20%; 104 | border-left: none; 105 | padding: 0.25em; 106 | box-sizing: border-box; 107 | } 108 | 109 | 110 | img { 111 | border: 0; 112 | max-width: 100%; 113 | } 114 | 115 | /* -- search page ----------------------------------------------------------- */ 116 | 117 | ul.search { 118 | margin: 10px 0 0 20px; 119 | padding: 0; 120 | } 121 | 122 | ul.search li { 123 | padding: 5px 0 5px 20px; 124 | background-image: url(file.png); 125 | background-repeat: no-repeat; 126 | background-position: 0 7px; 127 | } 128 | 129 | ul.search li a { 130 | font-weight: bold; 131 | } 132 | 133 | ul.search li p.context { 134 | color: #888; 135 | margin: 2px 0 0 30px; 136 | text-align: left; 137 | } 138 | 139 | ul.keywordmatches li.goodmatch a { 140 | font-weight: bold; 141 | } 142 | 143 | /* -- index page ------------------------------------------------------------ */ 144 | 145 | table.contentstable { 146 | width: 90%; 147 | margin-left: auto; 148 | margin-right: auto; 149 | } 150 | 151 | table.contentstable p.biglink { 152 | line-height: 150%; 153 | } 154 | 155 | a.biglink { 156 | font-size: 1.3em; 157 | } 158 | 159 | span.linkdescr { 160 | font-style: italic; 161 | padding-top: 5px; 162 | font-size: 90%; 163 | } 164 | 165 | /* -- general index --------------------------------------------------------- */ 166 | 167 | table.indextable { 168 | width: 100%; 169 | } 170 | 171 | table.indextable td { 172 | text-align: left; 173 | vertical-align: top; 174 | } 175 | 176 | table.indextable ul { 177 | margin-top: 0; 178 | margin-bottom: 0; 179 | list-style-type: none; 180 | } 181 | 182 | table.indextable > tbody > tr > td > ul { 183 | padding-left: 0em; 184 | } 185 | 186 | table.indextable tr.pcap { 187 | height: 10px; 188 | } 189 | 190 | table.indextable tr.cap { 191 | margin-top: 10px; 192 | background-color: #f2f2f2; 193 | } 194 | 195 | img.toggler { 196 | margin-right: 3px; 197 | margin-top: 3px; 198 | cursor: pointer; 199 | } 200 | 201 | div.modindex-jumpbox { 202 | border-top: 1px solid #ddd; 203 | border-bottom: 1px solid #ddd; 204 | margin: 1em 0 1em 0; 205 | padding: 0.4em; 206 | } 207 | 208 | div.genindex-jumpbox { 209 | border-top: 1px solid #ddd; 210 | border-bottom: 1px solid #ddd; 211 | margin: 1em 0 1em 0; 212 | padding: 0.4em; 213 | } 214 | 215 | /* -- domain module index --------------------------------------------------- */ 216 | 217 | table.modindextable td { 218 | padding: 2px; 219 | border-collapse: collapse; 220 | } 221 | 222 | /* -- general body styles --------------------------------------------------- */ 223 | 224 | div.body { 225 | min-width: 450px; 226 | max-width: 800px; 227 | } 228 | 229 | div.body p, div.body dd, div.body li, div.body blockquote { 230 | -moz-hyphens: auto; 231 | -ms-hyphens: auto; 232 | -webkit-hyphens: auto; 233 | hyphens: auto; 234 | } 235 | 236 | a.headerlink { 237 | visibility: hidden; 238 | } 239 | 240 | a.brackets:before, 241 | span.brackets > a:before{ 242 | content: "["; 243 | } 244 | 245 | a.brackets:after, 246 | span.brackets > a:after { 247 | content: "]"; 248 | } 249 | 250 | h1:hover > a.headerlink, 251 | h2:hover > a.headerlink, 252 | h3:hover > a.headerlink, 253 | h4:hover > a.headerlink, 254 | h5:hover > a.headerlink, 255 | h6:hover > a.headerlink, 256 | dt:hover > a.headerlink, 257 | caption:hover > a.headerlink, 258 | p.caption:hover > a.headerlink, 259 | div.code-block-caption:hover > a.headerlink { 260 | visibility: visible; 261 | } 262 | 263 | div.body p.caption { 264 | text-align: inherit; 265 | } 266 | 267 | div.body td { 268 | text-align: left; 269 | } 270 | 271 | .first { 272 | margin-top: 0 !important; 273 | } 274 | 275 | p.rubric { 276 | margin-top: 30px; 277 | font-weight: bold; 278 | } 279 | 280 | img.align-left, figure.align-left, .figure.align-left, object.align-left { 281 | clear: left; 282 | float: left; 283 | margin-right: 1em; 284 | } 285 | 286 | img.align-right, figure.align-right, .figure.align-right, object.align-right { 287 | clear: right; 288 | float: right; 289 | margin-left: 1em; 290 | } 291 | 292 | img.align-center, figure.align-center, .figure.align-center, object.align-center { 293 | display: block; 294 | margin-left: auto; 295 | margin-right: auto; 296 | } 297 | 298 | img.align-default, figure.align-default, .figure.align-default { 299 | display: block; 300 | margin-left: auto; 301 | margin-right: auto; 302 | } 303 | 304 | .align-left { 305 | text-align: left; 306 | } 307 | 308 | .align-center { 309 | text-align: center; 310 | } 311 | 312 | .align-default { 313 | text-align: center; 314 | } 315 | 316 | .align-right { 317 | text-align: right; 318 | } 319 | 320 | /* -- sidebars -------------------------------------------------------------- */ 321 | 322 | div.sidebar, 323 | aside.sidebar { 324 | margin: 0 0 0.5em 1em; 325 | border: 1px solid #ddb; 326 | padding: 7px; 327 | background-color: #ffe; 328 | width: 40%; 329 | float: right; 330 | clear: right; 331 | overflow-x: auto; 332 | } 333 | 334 | p.sidebar-title { 335 | font-weight: bold; 336 | } 337 | 338 | div.admonition, div.topic, blockquote { 339 | clear: left; 340 | } 341 | 342 | /* -- topics ---------------------------------------------------------------- */ 343 | 344 | div.topic { 345 | border: 1px solid #ccc; 346 | padding: 7px; 347 | margin: 10px 0 10px 0; 348 | } 349 | 350 | p.topic-title { 351 | font-size: 1.1em; 352 | font-weight: bold; 353 | margin-top: 10px; 354 | } 355 | 356 | /* -- admonitions ----------------------------------------------------------- */ 357 | 358 | div.admonition { 359 | margin-top: 10px; 360 | margin-bottom: 10px; 361 | padding: 7px; 362 | } 363 | 364 | div.admonition dt { 365 | font-weight: bold; 366 | } 367 | 368 | p.admonition-title { 369 | margin: 0px 10px 5px 0px; 370 | font-weight: bold; 371 | } 372 | 373 | div.body p.centered { 374 | text-align: center; 375 | margin-top: 25px; 376 | } 377 | 378 | /* -- content of sidebars/topics/admonitions -------------------------------- */ 379 | 380 | div.sidebar > :last-child, 381 | aside.sidebar > :last-child, 382 | div.topic > :last-child, 383 | div.admonition > :last-child { 384 | margin-bottom: 0; 385 | } 386 | 387 | div.sidebar::after, 388 | aside.sidebar::after, 389 | div.topic::after, 390 | div.admonition::after, 391 | blockquote::after { 392 | display: block; 393 | content: ''; 394 | clear: both; 395 | } 396 | 397 | /* -- tables ---------------------------------------------------------------- */ 398 | 399 | table.docutils { 400 | margin-top: 10px; 401 | margin-bottom: 10px; 402 | border: 0; 403 | border-collapse: collapse; 404 | } 405 | 406 | table.align-center { 407 | margin-left: auto; 408 | margin-right: auto; 409 | } 410 | 411 | table.align-default { 412 | margin-left: auto; 413 | margin-right: auto; 414 | } 415 | 416 | table caption span.caption-number { 417 | font-style: italic; 418 | } 419 | 420 | table caption span.caption-text { 421 | } 422 | 423 | table.docutils td, table.docutils th { 424 | padding: 1px 8px 1px 5px; 425 | border-top: 0; 426 | border-left: 0; 427 | border-right: 0; 428 | border-bottom: 1px solid #aaa; 429 | } 430 | 431 | table.footnote td, table.footnote th { 432 | border: 0 !important; 433 | } 434 | 435 | th { 436 | text-align: left; 437 | padding-right: 5px; 438 | } 439 | 440 | table.citation { 441 | border-left: solid 1px gray; 442 | margin-left: 1px; 443 | } 444 | 445 | table.citation td { 446 | border-bottom: none; 447 | } 448 | 449 | th > :first-child, 450 | td > :first-child { 451 | margin-top: 0px; 452 | } 453 | 454 | th > :last-child, 455 | td > :last-child { 456 | margin-bottom: 0px; 457 | } 458 | 459 | /* -- figures --------------------------------------------------------------- */ 460 | 461 | div.figure, figure { 462 | margin: 0.5em; 463 | padding: 0.5em; 464 | } 465 | 466 | div.figure p.caption, figcaption { 467 | padding: 0.3em; 468 | } 469 | 470 | div.figure p.caption span.caption-number, 471 | figcaption span.caption-number { 472 | font-style: italic; 473 | } 474 | 475 | div.figure p.caption span.caption-text, 476 | figcaption span.caption-text { 477 | } 478 | 479 | /* -- field list styles ----------------------------------------------------- */ 480 | 481 | table.field-list td, table.field-list th { 482 | border: 0 !important; 483 | } 484 | 485 | .field-list ul { 486 | margin: 0; 487 | padding-left: 1em; 488 | } 489 | 490 | .field-list p { 491 | margin: 0; 492 | } 493 | 494 | .field-name { 495 | -moz-hyphens: manual; 496 | -ms-hyphens: manual; 497 | -webkit-hyphens: manual; 498 | hyphens: manual; 499 | } 500 | 501 | /* -- hlist styles ---------------------------------------------------------- */ 502 | 503 | table.hlist { 504 | margin: 1em 0; 505 | } 506 | 507 | table.hlist td { 508 | vertical-align: top; 509 | } 510 | 511 | /* -- object description styles --------------------------------------------- */ 512 | 513 | .sig { 514 | font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; 515 | } 516 | 517 | .sig-name, code.descname { 518 | background-color: transparent; 519 | font-weight: bold; 520 | } 521 | 522 | .sig-name { 523 | font-size: 1.1em; 524 | } 525 | 526 | code.descname { 527 | font-size: 1.2em; 528 | } 529 | 530 | .sig-prename, code.descclassname { 531 | background-color: transparent; 532 | } 533 | 534 | .optional { 535 | font-size: 1.3em; 536 | } 537 | 538 | .sig-paren { 539 | font-size: larger; 540 | } 541 | 542 | .sig-param.n { 543 | font-style: italic; 544 | } 545 | 546 | /* C++ specific styling */ 547 | 548 | .sig-inline.c-texpr, 549 | .sig-inline.cpp-texpr { 550 | font-family: unset; 551 | } 552 | 553 | .sig.c .k, .sig.c .kt, 554 | .sig.cpp .k, .sig.cpp .kt { 555 | color: #0033B3; 556 | } 557 | 558 | .sig.c .m, 559 | .sig.cpp .m { 560 | color: #1750EB; 561 | } 562 | 563 | .sig.c .s, .sig.c .sc, 564 | .sig.cpp .s, .sig.cpp .sc { 565 | color: #067D17; 566 | } 567 | 568 | 569 | /* -- other body styles ----------------------------------------------------- */ 570 | 571 | ol.arabic { 572 | list-style: decimal; 573 | } 574 | 575 | ol.loweralpha { 576 | list-style: lower-alpha; 577 | } 578 | 579 | ol.upperalpha { 580 | list-style: upper-alpha; 581 | } 582 | 583 | ol.lowerroman { 584 | list-style: lower-roman; 585 | } 586 | 587 | ol.upperroman { 588 | list-style: upper-roman; 589 | } 590 | 591 | :not(li) > ol > li:first-child > :first-child, 592 | :not(li) > ul > li:first-child > :first-child { 593 | margin-top: 0px; 594 | } 595 | 596 | :not(li) > ol > li:last-child > :last-child, 597 | :not(li) > ul > li:last-child > :last-child { 598 | margin-bottom: 0px; 599 | } 600 | 601 | ol.simple ol p, 602 | ol.simple ul p, 603 | ul.simple ol p, 604 | ul.simple ul p { 605 | margin-top: 0; 606 | } 607 | 608 | ol.simple > li:not(:first-child) > p, 609 | ul.simple > li:not(:first-child) > p { 610 | margin-top: 0; 611 | } 612 | 613 | ol.simple p, 614 | ul.simple p { 615 | margin-bottom: 0; 616 | } 617 | 618 | dl.footnote > dt, 619 | dl.citation > dt { 620 | float: left; 621 | margin-right: 0.5em; 622 | } 623 | 624 | dl.footnote > dd, 625 | dl.citation > dd { 626 | margin-bottom: 0em; 627 | } 628 | 629 | dl.footnote > dd:after, 630 | dl.citation > dd:after { 631 | content: ""; 632 | clear: both; 633 | } 634 | 635 | dl.field-list { 636 | display: grid; 637 | grid-template-columns: fit-content(30%) auto; 638 | } 639 | 640 | dl.field-list > dt { 641 | font-weight: bold; 642 | word-break: break-word; 643 | padding-left: 0.5em; 644 | padding-right: 5px; 645 | } 646 | 647 | dl.field-list > dt:after { 648 | content: ":"; 649 | } 650 | 651 | dl.field-list > dd { 652 | padding-left: 0.5em; 653 | margin-top: 0em; 654 | margin-left: 0em; 655 | margin-bottom: 0em; 656 | } 657 | 658 | dl { 659 | margin-bottom: 15px; 660 | } 661 | 662 | dd > :first-child { 663 | margin-top: 0px; 664 | } 665 | 666 | dd ul, dd table { 667 | margin-bottom: 10px; 668 | } 669 | 670 | dd { 671 | margin-top: 3px; 672 | margin-bottom: 10px; 673 | margin-left: 30px; 674 | } 675 | 676 | dl > dd:last-child, 677 | dl > dd:last-child > :last-child { 678 | margin-bottom: 0; 679 | } 680 | 681 | dt:target, span.highlighted { 682 | background-color: #fbe54e; 683 | } 684 | 685 | rect.highlighted { 686 | fill: #fbe54e; 687 | } 688 | 689 | dl.glossary dt { 690 | font-weight: bold; 691 | font-size: 1.1em; 692 | } 693 | 694 | .versionmodified { 695 | font-style: italic; 696 | } 697 | 698 | .system-message { 699 | background-color: #fda; 700 | padding: 5px; 701 | border: 3px solid red; 702 | } 703 | 704 | .footnote:target { 705 | background-color: #ffa; 706 | } 707 | 708 | .line-block { 709 | display: block; 710 | margin-top: 1em; 711 | margin-bottom: 1em; 712 | } 713 | 714 | .line-block .line-block { 715 | margin-top: 0; 716 | margin-bottom: 0; 717 | margin-left: 1.5em; 718 | } 719 | 720 | .guilabel, .menuselection { 721 | font-family: sans-serif; 722 | } 723 | 724 | .accelerator { 725 | text-decoration: underline; 726 | } 727 | 728 | .classifier { 729 | font-style: oblique; 730 | } 731 | 732 | .classifier:before { 733 | font-style: normal; 734 | margin: 0.5em; 735 | content: ":"; 736 | } 737 | 738 | abbr, acronym { 739 | border-bottom: dotted 1px; 740 | cursor: help; 741 | } 742 | 743 | /* -- code displays --------------------------------------------------------- */ 744 | 745 | pre { 746 | overflow: auto; 747 | overflow-y: hidden; /* fixes display issues on Chrome browsers */ 748 | } 749 | 750 | pre, div[class*="highlight-"] { 751 | clear: both; 752 | } 753 | 754 | span.pre { 755 | -moz-hyphens: none; 756 | -ms-hyphens: none; 757 | -webkit-hyphens: none; 758 | hyphens: none; 759 | } 760 | 761 | div[class*="highlight-"] { 762 | margin: 1em 0; 763 | } 764 | 765 | td.linenos pre { 766 | border: 0; 767 | background-color: transparent; 768 | color: #aaa; 769 | } 770 | 771 | table.highlighttable { 772 | display: block; 773 | } 774 | 775 | table.highlighttable tbody { 776 | display: block; 777 | } 778 | 779 | table.highlighttable tr { 780 | display: flex; 781 | } 782 | 783 | table.highlighttable td { 784 | margin: 0; 785 | padding: 0; 786 | } 787 | 788 | table.highlighttable td.linenos { 789 | padding-right: 0.5em; 790 | } 791 | 792 | table.highlighttable td.code { 793 | flex: 1; 794 | overflow: hidden; 795 | } 796 | 797 | .highlight .hll { 798 | display: block; 799 | } 800 | 801 | div.highlight pre, 802 | table.highlighttable pre { 803 | margin: 0; 804 | } 805 | 806 | div.code-block-caption + div { 807 | margin-top: 0; 808 | } 809 | 810 | div.code-block-caption { 811 | margin-top: 1em; 812 | padding: 2px 5px; 813 | font-size: small; 814 | } 815 | 816 | div.code-block-caption code { 817 | background-color: transparent; 818 | } 819 | 820 | table.highlighttable td.linenos, 821 | span.linenos, 822 | div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ 823 | user-select: none; 824 | -webkit-user-select: text; /* Safari fallback only */ 825 | -webkit-user-select: none; /* Chrome/Safari */ 826 | -moz-user-select: none; /* Firefox */ 827 | -ms-user-select: none; /* IE10+ */ 828 | } 829 | 830 | div.code-block-caption span.caption-number { 831 | padding: 0.1em 0.3em; 832 | font-style: italic; 833 | } 834 | 835 | div.code-block-caption span.caption-text { 836 | } 837 | 838 | div.literal-block-wrapper { 839 | margin: 1em 0; 840 | } 841 | 842 | code.xref, a code { 843 | background-color: transparent; 844 | font-weight: bold; 845 | } 846 | 847 | h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { 848 | background-color: transparent; 849 | } 850 | 851 | .viewcode-link { 852 | float: right; 853 | } 854 | 855 | .viewcode-back { 856 | float: right; 857 | font-family: sans-serif; 858 | } 859 | 860 | div.viewcode-block:target { 861 | margin: -1px -10px; 862 | padding: 0 10px; 863 | } 864 | 865 | /* -- math display ---------------------------------------------------------- */ 866 | 867 | img.math { 868 | vertical-align: middle; 869 | } 870 | 871 | div.body div.math p { 872 | text-align: center; 873 | } 874 | 875 | span.eqno { 876 | float: right; 877 | } 878 | 879 | span.eqno a.headerlink { 880 | position: absolute; 881 | z-index: 1; 882 | } 883 | 884 | div.math:hover a.headerlink { 885 | visibility: visible; 886 | } 887 | 888 | /* -- printout stylesheet --------------------------------------------------- */ 889 | 890 | @media print { 891 | div.document, 892 | div.documentwrapper, 893 | div.bodywrapper { 894 | margin: 0 !important; 895 | width: 100%; 896 | } 897 | 898 | div.sphinxsidebar, 899 | div.related, 900 | div.footer, 901 | #top-link { 902 | display: none; 903 | } 904 | } -------------------------------------------------------------------------------- /docs/_static/css/custom.css: -------------------------------------------------------------------------------- 1 | 2 | /*# sourceMappingURL=custom.css.map */ -------------------------------------------------------------------------------- /docs/_static/css/theme.min.css: -------------------------------------------------------------------------------- 1 | @charset "UTF-8";@import url(https://fonts.googleapis.com/css?family=Inconsolata:400,700|Lato:300,400,400i,700,900);/*! Karma-CSS v1.9.5 MIT License | http://karmacss.com | https://github.com/accentdesign/karma-css */.container{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}@media (min-width:576px){.container{width:540px;max-width:100%}}@media (min-width:768px){.container{width:720px;max-width:100%}}@media (min-width:992px){.container{width:960px;max-width:100%}}@media (min-width:1200px){.container{width:1140px;max-width:100%}}.container-fluid{width:100%;padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-right:-15px;margin-left:-15px}.no-gutters{margin-right:0;margin-left:0}.no-gutters>.col,.no-gutters>[class*=col-]{padding-right:0;padding-left:0}.col,.col-1,.col-10,.col-11,.col-12,.col-2,.col-3,.col-4,.col-5,.col-6,.col-7,.col-8,.col-9,.col-auto,.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{width:100%;min-height:1px;padding-right:15px;padding-left:15px}.col{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.col-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:none}.col-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-1{-ms-flex-order:1;order:1}.order-2{-ms-flex-order:2;order:2}.order-3{-ms-flex-order:3;order:3}.order-4{-ms-flex-order:4;order:4}.order-5{-ms-flex-order:5;order:5}.order-6{-ms-flex-order:6;order:6}.order-7{-ms-flex-order:7;order:7}.order-8{-ms-flex-order:8;order:8}.order-9{-ms-flex-order:9;order:9}.order-10{-ms-flex-order:10;order:10}.order-11{-ms-flex-order:11;order:11}.order-12{-ms-flex-order:12;order:12}.offset-1{margin-left:8.333333%}.offset-2{margin-left:16.666667%}.offset-3{margin-left:25%}.offset-4{margin-left:33.333333%}.offset-5{margin-left:41.666667%}.offset-6{margin-left:50%}.offset-7{margin-left:58.333333%}.offset-8{margin-left:66.666667%}.offset-9{margin-left:75%}.offset-10{margin-left:83.333333%}.offset-11{margin-left:91.666667%}@media (min-width:576px){.col-sm{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:none}.col-sm-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-sm-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-sm-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-sm-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-sm-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-sm-1{-ms-flex-order:1;order:1}.order-sm-2{-ms-flex-order:2;order:2}.order-sm-3{-ms-flex-order:3;order:3}.order-sm-4{-ms-flex-order:4;order:4}.order-sm-5{-ms-flex-order:5;order:5}.order-sm-6{-ms-flex-order:6;order:6}.order-sm-7{-ms-flex-order:7;order:7}.order-sm-8{-ms-flex-order:8;order:8}.order-sm-9{-ms-flex-order:9;order:9}.order-sm-10{-ms-flex-order:10;order:10}.order-sm-11{-ms-flex-order:11;order:11}.order-sm-12{-ms-flex-order:12;order:12}.offset-sm-1{margin-left:8.333333%}.offset-sm-2{margin-left:16.666667%}.offset-sm-3{margin-left:25%}.offset-sm-4{margin-left:33.333333%}.offset-sm-5{margin-left:41.666667%}.offset-sm-6{margin-left:50%}.offset-sm-7{margin-left:58.333333%}.offset-sm-8{margin-left:66.666667%}.offset-sm-9{margin-left:75%}.offset-sm-10{margin-left:83.333333%}.offset-sm-11{margin-left:91.666667%}}@media (min-width:768px){.col-md{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:none}.col-md-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-md-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-md-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-md-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-md-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-md-1{-ms-flex-order:1;order:1}.order-md-2{-ms-flex-order:2;order:2}.order-md-3{-ms-flex-order:3;order:3}.order-md-4{-ms-flex-order:4;order:4}.order-md-5{-ms-flex-order:5;order:5}.order-md-6{-ms-flex-order:6;order:6}.order-md-7{-ms-flex-order:7;order:7}.order-md-8{-ms-flex-order:8;order:8}.order-md-9{-ms-flex-order:9;order:9}.order-md-10{-ms-flex-order:10;order:10}.order-md-11{-ms-flex-order:11;order:11}.order-md-12{-ms-flex-order:12;order:12}.offset-md-1{margin-left:8.333333%}.offset-md-2{margin-left:16.666667%}.offset-md-3{margin-left:25%}.offset-md-4{margin-left:33.333333%}.offset-md-5{margin-left:41.666667%}.offset-md-6{margin-left:50%}.offset-md-7{margin-left:58.333333%}.offset-md-8{margin-left:66.666667%}.offset-md-9{margin-left:75%}.offset-md-10{margin-left:83.333333%}.offset-md-11{margin-left:91.666667%}}@media (min-width:992px){.col-lg{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:none}.col-lg-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-lg-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-lg-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-lg-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-lg-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-lg-1{-ms-flex-order:1;order:1}.order-lg-2{-ms-flex-order:2;order:2}.order-lg-3{-ms-flex-order:3;order:3}.order-lg-4{-ms-flex-order:4;order:4}.order-lg-5{-ms-flex-order:5;order:5}.order-lg-6{-ms-flex-order:6;order:6}.order-lg-7{-ms-flex-order:7;order:7}.order-lg-8{-ms-flex-order:8;order:8}.order-lg-9{-ms-flex-order:9;order:9}.order-lg-10{-ms-flex-order:10;order:10}.order-lg-11{-ms-flex-order:11;order:11}.order-lg-12{-ms-flex-order:12;order:12}.offset-lg-1{margin-left:8.333333%}.offset-lg-2{margin-left:16.666667%}.offset-lg-3{margin-left:25%}.offset-lg-4{margin-left:33.333333%}.offset-lg-5{margin-left:41.666667%}.offset-lg-6{margin-left:50%}.offset-lg-7{margin-left:58.333333%}.offset-lg-8{margin-left:66.666667%}.offset-lg-9{margin-left:75%}.offset-lg-10{margin-left:83.333333%}.offset-lg-11{margin-left:91.666667%}}@media (min-width:1200px){.col-xl{-ms-flex-preferred-size:0;flex-basis:0;-ms-flex-positive:1;flex-grow:1;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;width:auto;max-width:none}.col-xl-1{-ms-flex:0 0 8.333333%;flex:0 0 8.333333%;max-width:8.333333%}.col-xl-2{-ms-flex:0 0 16.666667%;flex:0 0 16.666667%;max-width:16.666667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%}.col-xl-5{-ms-flex:0 0 41.666667%;flex:0 0 41.666667%;max-width:41.666667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.333333%;flex:0 0 58.333333%;max-width:58.333333%}.col-xl-8{-ms-flex:0 0 66.666667%;flex:0 0 66.666667%;max-width:66.666667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.333333%;flex:0 0 83.333333%;max-width:83.333333%}.col-xl-11{-ms-flex:0 0 91.666667%;flex:0 0 91.666667%;max-width:91.666667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}.order-xl-1{-ms-flex-order:1;order:1}.order-xl-2{-ms-flex-order:2;order:2}.order-xl-3{-ms-flex-order:3;order:3}.order-xl-4{-ms-flex-order:4;order:4}.order-xl-5{-ms-flex-order:5;order:5}.order-xl-6{-ms-flex-order:6;order:6}.order-xl-7{-ms-flex-order:7;order:7}.order-xl-8{-ms-flex-order:8;order:8}.order-xl-9{-ms-flex-order:9;order:9}.order-xl-10{-ms-flex-order:10;order:10}.order-xl-11{-ms-flex-order:11;order:11}.order-xl-12{-ms-flex-order:12;order:12}.offset-xl-1{margin-left:8.333333%}.offset-xl-2{margin-left:16.666667%}.offset-xl-3{margin-left:25%}.offset-xl-4{margin-left:33.333333%}.offset-xl-5{margin-left:41.666667%}.offset-xl-6{margin-left:50%}.offset-xl-7{margin-left:58.333333%}.offset-xl-8{margin-left:66.666667%}.offset-xl-9{margin-left:75%}.offset-xl-10{margin-left:83.333333%}.offset-xl-11{margin-left:91.666667%}}*{box-sizing:border-box;padding:0;margin:0}::after,::before{box-sizing:border-box}html{font-size:62.5%;line-height:1.6}body{font-family:Lato,sans-serif;font-size:16px;font-weight:400;color:#5f5f5f;background:#fafbfc}main{display:block}a{color:#33c3f0;text-decoration:none;background-color:transparent;transition:color linear 250ms}a:hover{color:#10aee0;text-decoration:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}::-moz-focus-inner{padding:0;border:0}.button{box-sizing:border-box;display:inline-block;padding:.8rem 1rem;overflow:visible;font-family:inherit;font-size:1.5rem;font-weight:400;line-height:1.5;color:#5f5f5f;text-align:center;text-decoration:none;white-space:nowrap;cursor:pointer;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-color:#fff;border:1px solid #e6e6e6;border-radius:.25rem;transition:background-color linear 250ms,border-color linear 250ms}.button:focus,.button:hover{color:#5f5f5f;background-color:#e6e6e6;border-color:#cdcdcd;outline:0}.button.button-outline{background-color:transparent;transition:background-color linear 250ms,border-color linear 250ms,color linear 250ms}.button.button-outline:focus,.button.button-outline:hover{color:#464646;background-color:transparent;border-color:#cdcdcd;outline:0}.button.button-clear{background-color:transparent;border-color:transparent;transition:background-color linear 250ms,border-color linear 250ms,color linear 250ms}.button.button-clear:focus,.button.button-clear:hover{color:#464646;background-color:transparent;border-color:transparent;outline:0}.button.button-primary{color:#fff;background-color:#33c3f0;border-color:#1bbcee}.button.button-primary:focus,.button.button-primary:hover{color:#fff;background-color:#10aee0;border-color:#0f9cc8;outline:0}.button.button-outline.button-primary{color:#33c3f0;background-color:transparent;border-color:#33c3f0}.button.button-outline.button-primary:focus,.button.button-outline.button-primary:hover{color:#10aee0;background-color:transparent;border-color:#10aee0;outline:0}.button.button-clear.button-primary{color:#33c3f0;background-color:transparent;border-color:transparent}.button.button-clear.button-primary:focus,.button.button-clear.button-primary:hover{color:#10aee0;background-color:transparent;border-color:transparent;outline:0}.button.button-secondary{color:#111;background-color:#f0f0f0;border-color:#e3e3e3}.button.button-secondary:focus,.button.button-secondary:hover{color:#111;background-color:#d7d7d7;border-color:#cacaca;outline:0}.button.button-outline.button-secondary{color:#f0f0f0;background-color:transparent;border-color:#f0f0f0}.button.button-outline.button-secondary:focus,.button.button-outline.button-secondary:hover{color:#d7d7d7;background-color:transparent;border-color:#d7d7d7;outline:0}.button.button-clear.button-secondary{color:#f0f0f0;background-color:transparent;border-color:transparent}.button.button-clear.button-secondary:focus,.button.button-clear.button-secondary:hover{color:#d7d7d7;background-color:transparent;border-color:transparent;outline:0}code,kbd,pre,samp{font-family:Inconsolata,monospace}code{padding:.2rem .5rem;font-size:100%;color:#5f5f5f;word-break:break-word;background:#e7eaeb;border:1px solid #e6e6e6;border-radius:.25rem}pre{display:block;padding:2rem;margin-bottom:2.5rem;overflow-x:auto;font-size:90%;color:#5f5f5f;white-space:pre;background:#e7eaeb;border:1px solid #e6e6e6;border-radius:.25rem}pre code{font-size:inherit;color:inherit;word-break:normal}[disabled]{cursor:not-allowed}form{margin-bottom:2.5rem}input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=url],input[type=week]{box-sizing:border-box;margin-bottom:1.5rem;font-family:inherit;line-height:1.5;color:#5f5f5f;background:#fff;border:1px solid #e6e6e6;border-radius:.25rem;box-shadow:none;transition:background linear 250ms,border-color linear 250ms;padding:.8rem 1rem;font-size:1.5rem;max-width:100%;-webkit-appearance:none}input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=url]:focus,input[type=week]:focus{background:#fff;border-color:#33c3f0;outline:0}input[type=date],input[type=datetime-local],input[type=datetime],input[type=month],input[type=week]{-webkit-appearance:listbox;height:calc(3.85rem + 2px)}input[type=checkbox],input[type=radio]{margin-right:1rem}::-webkit-inner-spin-button,::-webkit-outer-spin-button{height:auto}::-webkit-datetime-edit-fields-wrapper{padding:0;margin:0}::-webkit-input-placeholder{color:#b9b9b9;opacity:1}::-moz-placeholder{color:#b9b9b9;opacity:1}:-ms-input-placeholder{color:#b9b9b9;opacity:1}::-ms-input-placeholder{color:#b9b9b9;opacity:1}::placeholder{color:#b9b9b9;opacity:1}textarea{box-sizing:border-box;margin-bottom:1.5rem;font-family:inherit;line-height:1.5;color:#5f5f5f;background:#fff;border:1px solid #e6e6e6;border-radius:.25rem;box-shadow:none;transition:background linear 250ms,border-color linear 250ms;padding:.8rem 1rem;font-size:1.5rem;max-width:100%;-webkit-appearance:none;overflow:auto}textarea:focus{background:#fff;border-color:#33c3f0;outline:0}select{box-sizing:border-box;margin-bottom:1.5rem;font-family:inherit;line-height:1.5;color:#5f5f5f;background:#fff;border:1px solid #e6e6e6;border-radius:.25rem;box-shadow:none;transition:background linear 250ms,border-color linear 250ms;padding:.8rem 1rem;font-size:1.5rem;max-width:100%;text-transform:none}select:focus{background:#fff;border-color:#33c3f0;outline:0}select:not([multiple]){height:calc(3.85rem + 2px)}label{display:block;margin-bottom:.5rem;font-weight:600}legend{box-sizing:border-box;display:block;max-width:100%;margin-bottom:.5rem;font-weight:600;color:inherit;white-space:normal}fieldset{margin-bottom:1.5rem;border-width:0}hr{box-sizing:content-box;height:0;margin:1.5rem 0;overflow:visible;border:0;border-top:1px solid #e6e6e6}img{border-style:none}figcaption{display:block}figure{display:block;margin:0 0 2.5rem}ul{padding-left:2rem;margin-bottom:2.5rem;list-style:circle outside}ul ol,ul ul{margin:0}ol{padding-left:1.7rem;margin-bottom:2.5rem;list-style:decimal outside}ol ol,ol ul{margin:0}dl{margin-bottom:2.5rem}dl dt{margin:0;font-weight:600}dl dd{margin:0 0 2.5rem 2.5rem}table{width:100%;max-width:100%;margin-bottom:2.5rem;font-size:90%;border-spacing:0;border-collapse:collapse;background-color:transparent}caption{padding:.85rem .85rem}th{padding:.85rem .85rem;text-align:left;vertical-align:top}td{padding:.85rem .85rem;text-align:left;vertical-align:top;border-top:1px solid #e6e6e6}.table-bordered,table.docutils.field-list,table.docutils:not(.footnote):not(.citation){border:solid 1px #e6e6e6}.table-headed th,table.docutils.field-list th,table.docutils:not(.footnote):not(.citation) th{background-color:#e7e9ec}.table-striped tbody tr:nth-child(odd),table.docutils:not(.footnote):not(.citation) tbody tr:nth-child(odd){background-color:#fafafa}.table-hover tbody tr:hover{background-color:#f5f5f5}#search-results .document>.section .toctree-wrapper .caption,#search-results h2,#search-results ul.search>li>a,.document>.section .toctree-wrapper #search-results .caption,.document>.section .toctree-wrapper .caption,.h1,.h2,.h3,.h4,.h5,.h6,h1,h2,h3,h4,h5,h6{font-family:Lato,sans-serif;color:#5f5f5f}#search-results .document>.section .toctree-wrapper .caption small,#search-results h2 small,#search-results ul.search>li>a small,.document>.section .toctree-wrapper #search-results .caption small,.document>.section .toctree-wrapper .caption small,.h1 small,.h2 small,.h3 small,.h4 small,.h5 small,.h6 small,h1 small,h2 small,h3 small,h4 small,h5 small,h6 small{font-size:65%;line-height:1}#search-results .document>.section .toctree-wrapper .caption,#search-results h2,.document>.section .toctree-wrapper #search-results .caption,.h1,h1{margin:4rem 0 1.5rem;font-size:32px;font-weight:700;line-height:1.2}.document>.section .toctree-wrapper .caption,.h2,h2{margin:4rem 0 1.5rem;font-size:24px;font-weight:700;line-height:1.25}#search-results ul.search>li>a,.h3,h3{margin:4rem 0 1.5rem;font-size:20.8px;font-weight:700;line-height:1.3}.h4,h4{margin:4rem 0 1.5rem;font-size:17.6px;font-weight:700;line-height:1.35}.h5,h5{margin:4rem 0 1.5rem;font-size:16px;font-weight:700;line-height:1.5}.h6,h6{margin:4rem 0 1.5rem;font-size:14.4px;font-weight:700;line-height:1.6}abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted}p{margin-bottom:2.5rem}blockquote{padding:1rem 1.5rem;margin-bottom:2.5rem;border-left:3px solid #e6e6e6}b,strong{font-weight:700}small{font-size:80%}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}.admonition,.alert{position:relative;padding:1.5rem 2rem;margin-bottom:2.5rem;border:1px solid #e6e6e6;border-radius:.25rem}.admonition.hint,.admonition.important,.admonition.tip,.alert-green{background:#bcf0c2;border:1px solid #a8ebaf;color:#5f5f5f}.admonition.danger,.admonition.error,.alert-red{background:#ffd2cf;border:1px solid #ffbab6;color:#5f5f5f}.admonition.note,.alert-blue{background:#ccf1ff;border:1px solid #b2e9ff;color:#5f5f5f}.admonition.attention,.admonition.caution,.admonition.warning,.alert-orange{background:#ffe5ce;border:1px solid #ffd7b4;color:#5f5f5f}.icon-input{max-width:100%;display:-ms-inline-flexbox;display:inline-flex;font-size:1.5rem;margin-bottom:1.5rem;position:relative}.icon-input input{-ms-flex:1 1 auto;flex:1 1 auto;font-size:1em;margin:0;padding-right:2.65em}.icon-input [class*=icon-]{position:absolute;top:0;right:0;bottom:auto;left:auto;color:#b9b9b9;height:100%;font-size:1em;line-height:1;opacity:1;pointer-events:none;text-align:center;width:2.65em}.icon-input [class*=icon-]:before{position:absolute;top:50%;right:auto;bottom:auto;left:0;margin:-.5em 0;text-align:center;width:100%}@font-face{font-family:fontello;src:url(../font/fontello.eot?44759829);src:url(../font/fontello.eot?44759829#iefix) format("embedded-opentype"),url(../font/fontello.woff2?44759829) format("woff2"),url(../font/fontello.woff?44759829) format("woff"),url(../font/fontello.ttf?44759829) format("truetype"),url(../font/fontello.svg?44759829#fontello) format("svg");font-weight:400;font-style:normal}[class*=" icon-"]:before,[class^=icon-]:before{font-family:fontello;font-style:normal;font-weight:400;speak:none;display:inline-block;text-decoration:inherit;width:1em;margin-right:.2em;text-align:center;font-variant:normal;text-transform:none;line-height:1em;margin-left:.2em;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.icon-search:before{content:'\e800'}.icon-edit:before{content:'\e801'}.icon-download:before{content:'\e802'}.icon-attention:before{content:'\e804'}.icon-info-circled:before{content:'\e805'}.icon-attention-circled:before{content:'\e810'}.icon-github-circled:before{content:'\f09b'}.icon-menu:before{content:'\f0c9'}.icon-lightbulb:before{content:'\f0eb'}.icon-bitbucket:before{content:'\f171'}.icon-gitlab:before{content:'\f296'}.admonition .admonition-title{font-weight:700;margin-bottom:.5rem}.admonition .admonition-title:before{font-family:fontello;padding-right:1rem}.admonition :last-child{margin-bottom:0}.admonition.attention .admonition-title:before,.admonition.caution .admonition-title:before,.admonition.warning .admonition-title:before{content:"\e804"}.admonition.danger .admonition-title:before,.admonition.error .admonition-title:before{content:"\e810"}.admonition.important .admonition-title:before{content:"\e810"}.admonition.hint .admonition-title:before,.admonition.tip .admonition-title:before{content:"\f0eb"}.admonition.note .admonition-title:before{content:"\e801"}.breadcrumbs-outer{background:#fafbfc;border:solid 1px #e6e6e6}.breadcrumbs{display:-ms-flexbox;display:flex;list-style:none;margin:0;padding:1rem 0}.breadcrumbs li+li:not(.breadcrumbs-aside):before{padding:0 1rem;content:"•"}.breadcrumbs .breadcrumbs-aside{margin-left:auto}.breadcrumbs code{padding:0;border:none;background:0 0;font-family:Lato,sans-serif;font-size:initial}.breadcrumbs code.literal{color:#5f5f5f}@media (max-width:991px){ul.breadcrumbs .breadcrumbs-aside{display:none}}.footer{color:rgba(0,0,0,.54);padding-top:4rem;padding-bottom:4rem}header{background:#24292e;padding:2rem 0}header .container{display:-ms-flexbox;display:flex;-ms-flex-direction:row;flex-direction:row;-ms-flex-align:center;align-items:center}header .site-nav-toggle{color:#f5f6f7;font-size:3.5rem;margin-left:-1rem;padding:.5rem 1rem .5rem 0;cursor:pointer}header .site-title{color:#fff;font-size:2rem;font-weight:400}@media (max-width:991px){header{position:fixed;top:0;right:auto;bottom:auto;left:auto;padding:0;-webkit-transform:translateY(0);transform:translateY(0);transition:-webkit-transform 250ms ease-in-out;transition:transform 250ms ease-in-out;transition:transform 250ms ease-in-out,-webkit-transform 250ms ease-in-out;width:100%;z-index:101}header.up{-webkit-transform:translateY(-100%);transform:translateY(-100%)}header .site-title{font-size:1.5rem}}.main-outer{background:#f5f6f7;padding-top:3rem;padding-bottom:10rem}#search-results .document>.section .toctree-wrapper .document>.section>.caption,#search-results .document>.section>h2,.document>.section .toctree-wrapper #search-results .document>.section>.caption,.document>.section>h1{margin-top:0;margin-bottom:4rem}.site-nav code.literal,.site-nav tt.literal{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.site-nav-tree .caption{font-weight:700}.site-nav-tree ul{list-style-type:none;padding-left:0}.site-nav-tree ul ul{margin-left:1.5rem}.site-nav-tree li{line-height:1.8}.site-nav-tree>ul>li:not(.current)>ul{display:none}.site-nav-tree a{color:rgba(0,0,0,.54)}.site-nav-tree a.current,.site-nav-tree a:hover{color:rgba(0,0,0,.87)}@media (max-width:991px){body{padding-top:6.6rem}.main-outer{position:relative}.site-nav{position:fixed;top:0;right:0;bottom:0;left:0;background:#f5f6f7;height:100vh;overflow-y:scroll;padding-top:10rem;-webkit-transform:translateX(-100%);transform:translateX(-100%);transition:-webkit-transform 250ms linear;transition:transform 250ms linear;transition:transform 250ms linear,-webkit-transform 250ms linear;z-index:100}body.nav-in{overflow:hidden}body.nav-in .site-nav{-webkit-transform:translateX(0);transform:translateX(0)}body.nav-in .site-nav .icon-input{width:100%}}.docutils.container{width:100%;margin:0;padding:0}#search-results .document>.section .toctree-wrapper .caption,#search-results h2,.document>.section .toctree-wrapper #search-results .caption{margin-bottom:5rem}#search-results ul.search{list-style-type:none;margin-top:3rem;padding:0}#search-results ul.search>li:not(:last-child){padding-bottom:3rem;border-bottom:solid 1px #e6e6e6;margin-bottom:3rem}.headerlink{visibility:hidden;padding-left:.5rem;opacity:.3}.headerlink:hover{opacity:.6}#search-results .document>.section .toctree-wrapper .caption:hover>a.headerlink,#search-results h2:hover>a.headerlink,#search-results ul.search>li>a:hover>a.headerlink,.caption-text:hover>a.headerlink,.caption:hover>a.headerlink,.code-block-caption:hover>a.headerlink,.document>.section .toctree-wrapper #search-results .caption:hover>a.headerlink,.document>.section .toctree-wrapper .caption:hover>a.headerlink,caption:hover>a.headerlink,dt:hover>a.headerlink,h1:hover>a.headerlink,h2:hover>a.headerlink,h3:hover>a.headerlink,h4:hover>a.headerlink,h5:hover>a.headerlink,h6:hover>a.headerlink{visibility:visible}.citation-reference,.footnote-reference{font-size:90%;position:relative;top:-.6rem}.rubric{margin-bottom:1.25rem;font-weight:700}img{min-height:1px;max-width:100%;height:auto}.align-left{float:left;margin-right:2.5rem;margin-bottom:2.5rem}.align-center{margin:auto;display:block}.align-center.figure{text-align:center}.align-right{float:right;margin-left:2.5rem;margin-bottom:2.5rem}.sidebar{border:1px solid #e6e6e6;margin:0 0 2.5rem 2.5rem;padding:2.5rem;background-color:#f0f0f0;width:40%;float:right}.sidebar-title{background:#f5f6f7;font-weight:700;margin-top:-2.5rem;margin-right:-2.5rem;margin-bottom:2.5rem;margin-left:-2.5rem;padding:.5rem 1rem}table.docutils.footnote{color:#aaa;width:auto}table.docutils.footnote td{border:0;padding-left:0;padding-right:2rem}table.docutils.footnote td:not(.label){width:100%}table.docutils.footnote td em+p{display:inline-block}table.docutils.footnote td p.last{margin-bottom:0}.figure p.caption{font-style:italic}ol.arabic{list-style-type:decimal}ol.loweralpha{list-style-type:lower-alpha}ol.upperalpha{list-style-type:upper-alpha}ol.lowerroman{list-style-type:lower-roman}ol.upperroman{list-style-type:upper-roman}dd p,li p{margin-bottom:1.25rem}dd p:last-child,li p:last-child{margin-bottom:0}.line-block{margin-bottom:2.5rem;margin-left:2.5rem}.line-block .line-block{margin-bottom:0;margin-left:2rem}blockquote .attribution{margin-bottom:0}.guilabel{border:1px solid #33c3f0;background:#c2edfa;font-size:80%;font-weight:700;border-radius:.25rem;padding:.15rem .5rem;margin:auto .2rem}div[class^=highlight-]{background:#e7eaeb;margin-bottom:2.5rem;overflow-x:auto}div[class^=highlight-] pre{margin-bottom:0}td.linenos pre{margin:0;border:0;border-radius:0;border-right:1px solid #e6e6e6}td.code{width:100%}td.code pre{margin:0;border:0;border-radius:0}table.highlighttable{font-size:100%;border:1px solid #e6e6e6;border-radius:.25rem;margin-bottom:0}table.highlighttable td{padding:0}code.literal,tt.literal{background:#fff;color:#ff4136;font-size:90%}a code,a tt,code.xref,tt.xref{color:#111}code.download,tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}code.download::before,tt.download::before{font-family:fontello;content:"\e802";padding-right:.5rem}dl:not(.docutils) dt{margin:.6rem 0;font-size:90%;line-height:normal;background:rgba(51,195,240,.1);color:rgba(51,195,240,.9);border-top:solid 3px #33c3f0;padding:.6rem}dl:not(.docutils) dl dt{border:none;border-left:solid 3px #e6e6e6;background:#f0f0f0;color:#5f5f5f}dl:not(.docutils) code.descclassname,dl:not(.docutils) code.descname,dl:not(.docutils) tt.descclassname,dl:not(.docutils) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%}dl:not(.docutils) code.descname,dl:not(.docutils) tt.descname{font-weight:700}dl:not(.docutils).data dt{display:inline-block}.align-top{vertical-align:top}.align-bottom{vertical-align:bottom}.align-middle{vertical-align:middle}.align-baseline{vertical-align:baseline}.clearfix::after{display:block;clear:both;content:""}.b-white{background-color:#fff}.c-white{color:#fff}.b-black{background-color:#111}.c-black{color:#111}.b-primary{background-color:#33c3f0}.c-primary{color:#33c3f0}.b-secondary{background-color:#f0f0f0}.c-secondary{color:#f0f0f0}.b-aqua{background-color:#7fdbff}.c-aqua{color:#7fdbff}.b-blue{background-color:#0074d9}.c-blue{color:#0074d9}.b-navy{background-color:#001f3f}.c-navy{color:#001f3f}.b-teal{background-color:#39cccc}.c-teal{color:#39cccc}.b-green{background-color:#2ecc40}.c-green{color:#2ecc40}.b-olive{background-color:#3d9970}.c-olive{color:#3d9970}.b-lime{background-color:#01ff70}.c-lime{color:#01ff70}.b-yellow{background-color:#ffdc00}.c-yellow{color:#ffdc00}.b-orange{background-color:#ff851b}.c-orange{color:#ff851b}.b-red{background-color:#ff4136}.c-red{color:#ff4136}.b-fuchsia{background-color:#f012be}.c-fuchsia{color:#f012be}.b-purple{background-color:#b10dc9}.c-purple{color:#b10dc9}.b-maroon{background-color:#85144b}.c-maroon{color:#85144b}.b-silver{background-color:#ddd}.c-silver{color:#ddd}.b-gray{background-color:#aaa}.c-gray{color:#aaa}.b-facebook{background-color:#3b5999}.c-facebook{color:#3b5999}.b-twitter{background-color:#55acee}.c-twitter{color:#55acee}.b-linkedin{background-color:#0077b5}.c-linkedin{color:#0077b5}.b-googleplus{background-color:#dd4b39}.c-googleplus{color:#dd4b39}.b-instagram{background-color:#e4405f}.c-instagram{color:#e4405f}.b-pinterest{background-color:#bd081c}.c-pinterest{color:#bd081c}.b-cinder{background-color:#24292e}.c-cinder{color:#24292e}.b-whitesmoke{background-color:#f5f6f7}.c-whitesmoke{color:#f5f6f7}.b-solitude{background-color:#fafbfc}.c-solitude{color:#fafbfc}.disabled{cursor:not-allowed}.move{cursor:move}.pointer{cursor:pointer}.d-block{display:block}.d-hidden{display:none!important}.d-flex{display:-ms-flexbox;display:flex}.d-grid{display:grid}.d-inline{display:inline}.d-inline-block{display:inline-block}.d-inline-flex{display:-ms-inline-flexbox;display:inline-flex}.d-table{display:table}.d-table-cell{display:table-cell}.flex-row{-ms-flex-direction:row;flex-direction:row}.flex-column{-ms-flex-direction:column;flex-direction:column}.flex-row-reverse{-ms-flex-direction:row-reverse;flex-direction:row-reverse}.flex-column-reverse{-ms-flex-direction:column-reverse;flex-direction:column-reverse}.justify-content-start{-ms-flex-pack:start;justify-content:flex-start}.justify-content-end{-ms-flex-pack:end;justify-content:flex-end}.justify-content-center{-ms-flex-pack:center;justify-content:center}.justify-content-between{-ms-flex-pack:justify;justify-content:space-between}.justify-content-around{-ms-flex-pack:distribute;justify-content:space-around}.align-items-start{-ms-flex-align:start;align-items:flex-start}.align-items-end{-ms-flex-align:end;align-items:flex-end}.align-items-center{-ms-flex-align:center;align-items:center}.align-items-baseline{-ms-flex-align:baseline;align-items:baseline}.align-items-stretch{-ms-flex-align:stretch;align-items:stretch}.flex-nowrap{-ms-flex-wrap:nowrap;flex-wrap:nowrap}.flex-wrap{-ms-flex-wrap:wrap;flex-wrap:wrap}.flex-wrap-reverse{-ms-flex-wrap:wrap-reverse;flex-wrap:wrap-reverse}.align-self-start{-ms-flex-item-align:start;align-self:flex-start}.align-self-end{-ms-flex-item-align:end;align-self:flex-end}.align-self-center{-ms-flex-item-align:center;align-self:center}.align-self-baseline{-ms-flex-item-align:baseline;align-self:baseline}.align-self-stretch{-ms-flex-item-align:stretch;align-self:stretch}.pull-left{float:left!important}.pull-right{float:right!important}.img-fluid{display:block;width:100%;max-width:100%;height:auto;min-height:1px}.list-style-none{list-style:none!important}.list-style-reset{padding:0;margin:0;list-style:none!important}.scroll-x{overflow-x:auto}.noscroll{overflow:hidden}.fixed{position:fixed}.relative{position:relative}.absolute{position:absolute}@media print{.no-print,.no-print *{display:none!important}}.full-height{height:100%}.full-visual-height{height:100vh}.full-width{box-sizing:border-box;width:100%}.max-full-width{box-sizing:border-box;max-width:100%}.margin-zero{margin:0}.m-auto{margin:auto}.mt-auto{margin-top:auto}.mr-auto{margin-right:auto}.mb-auto{margin-bottom:auto}.ml-auto{margin-left:auto}.push-auto{margin-right:auto;margin-left:auto}.text-left{text-align:left}.text-right{text-align:right}.text-center{text-align:center}.text-just{text-align:justify}.strong{font-weight:700}.lead{font-weight:300}.muted{opacity:.7}.nowrap{white-space:nowrap}.small{font-size:80%}.uppercase{text-transform:uppercase}.text-shadow{text-shadow:0 2px 4px rgba(0,0,0,.5)}.flip-x{-webkit-transform:scale(-1,1);transform:scale(-1,1)}.flip-y{-webkit-transform:scale(1,-1);transform:scale(1,-1)}.flip-both{-webkit-transform:scale(-1,-1);transform:scale(-1,-1)}.hidden-xs-up{display:none!important}@media (max-width:575px){.hidden-xs-down{display:none!important}}@media (min-width:)) and (max-width:575px){.hidden-xs{display:none!important}}@media (min-width:576px){.hidden-sm-up{display:none!important}}@media (max-width:767px){.hidden-sm-down{display:none!important}}@media (min-width:576px) and (max-width:767px){.hidden-sm{display:none!important}}@media (min-width:768px){.hidden-md-up{display:none!important}}@media (max-width:991px){.hidden-md-down{display:none!important}}@media (min-width:768px) and (max-width:991px){.hidden-md{display:none!important}}@media (min-width:992px){.hidden-lg-up{display:none!important}}@media (max-width:1199px){.hidden-lg-down{display:none!important}}@media (min-width:992px) and (max-width:1199px){.hidden-lg{display:none!important}}@media (min-width:1200px){.hidden-xl-up{display:none!important}}.hidden-xl-down{display:none!important}@media (min-width:1200px) and (max-width:)){.hidden-xl{display:none!important}} 2 | /*# sourceMappingURL=theme.min.css.map */ -------------------------------------------------------------------------------- /docs/_static/doctools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * doctools.js 3 | * ~~~~~~~~~~~ 4 | * 5 | * Sphinx JavaScript utilities for all documentation. 6 | * 7 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | /** 13 | * select a different prefix for underscore 14 | */ 15 | $u = _.noConflict(); 16 | 17 | /** 18 | * make the code below compatible with browsers without 19 | * an installed firebug like debugger 20 | if (!window.console || !console.firebug) { 21 | var names = ["log", "debug", "info", "warn", "error", "assert", "dir", 22 | "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", 23 | "profile", "profileEnd"]; 24 | window.console = {}; 25 | for (var i = 0; i < names.length; ++i) 26 | window.console[names[i]] = function() {}; 27 | } 28 | */ 29 | 30 | /** 31 | * small helper function to urldecode strings 32 | * 33 | * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL 34 | */ 35 | jQuery.urldecode = function(x) { 36 | if (!x) { 37 | return x 38 | } 39 | return decodeURIComponent(x.replace(/\+/g, ' ')); 40 | }; 41 | 42 | /** 43 | * small helper function to urlencode strings 44 | */ 45 | jQuery.urlencode = encodeURIComponent; 46 | 47 | /** 48 | * This function returns the parsed url parameters of the 49 | * current request. Multiple values per key are supported, 50 | * it will always return arrays of strings for the value parts. 51 | */ 52 | jQuery.getQueryParameters = function(s) { 53 | if (typeof s === 'undefined') 54 | s = document.location.search; 55 | var parts = s.substr(s.indexOf('?') + 1).split('&'); 56 | var result = {}; 57 | for (var i = 0; i < parts.length; i++) { 58 | var tmp = parts[i].split('=', 2); 59 | var key = jQuery.urldecode(tmp[0]); 60 | var value = jQuery.urldecode(tmp[1]); 61 | if (key in result) 62 | result[key].push(value); 63 | else 64 | result[key] = [value]; 65 | } 66 | return result; 67 | }; 68 | 69 | /** 70 | * highlight a given string on a jquery object by wrapping it in 71 | * span elements with the given class name. 72 | */ 73 | jQuery.fn.highlightText = function(text, className) { 74 | function highlight(node, addItems) { 75 | if (node.nodeType === 3) { 76 | var val = node.nodeValue; 77 | var pos = val.toLowerCase().indexOf(text); 78 | if (pos >= 0 && 79 | !jQuery(node.parentNode).hasClass(className) && 80 | !jQuery(node.parentNode).hasClass("nohighlight")) { 81 | var span; 82 | var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); 83 | if (isInSVG) { 84 | span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); 85 | } else { 86 | span = document.createElement("span"); 87 | span.className = className; 88 | } 89 | span.appendChild(document.createTextNode(val.substr(pos, text.length))); 90 | node.parentNode.insertBefore(span, node.parentNode.insertBefore( 91 | document.createTextNode(val.substr(pos + text.length)), 92 | node.nextSibling)); 93 | node.nodeValue = val.substr(0, pos); 94 | if (isInSVG) { 95 | var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); 96 | var bbox = node.parentElement.getBBox(); 97 | rect.x.baseVal.value = bbox.x; 98 | rect.y.baseVal.value = bbox.y; 99 | rect.width.baseVal.value = bbox.width; 100 | rect.height.baseVal.value = bbox.height; 101 | rect.setAttribute('class', className); 102 | addItems.push({ 103 | "parent": node.parentNode, 104 | "target": rect}); 105 | } 106 | } 107 | } 108 | else if (!jQuery(node).is("button, select, textarea")) { 109 | jQuery.each(node.childNodes, function() { 110 | highlight(this, addItems); 111 | }); 112 | } 113 | } 114 | var addItems = []; 115 | var result = this.each(function() { 116 | highlight(this, addItems); 117 | }); 118 | for (var i = 0; i < addItems.length; ++i) { 119 | jQuery(addItems[i].parent).before(addItems[i].target); 120 | } 121 | return result; 122 | }; 123 | 124 | /* 125 | * backward compatibility for jQuery.browser 126 | * This will be supported until firefox bug is fixed. 127 | */ 128 | if (!jQuery.browser) { 129 | jQuery.uaMatch = function(ua) { 130 | ua = ua.toLowerCase(); 131 | 132 | var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || 133 | /(webkit)[ \/]([\w.]+)/.exec(ua) || 134 | /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || 135 | /(msie) ([\w.]+)/.exec(ua) || 136 | ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || 137 | []; 138 | 139 | return { 140 | browser: match[ 1 ] || "", 141 | version: match[ 2 ] || "0" 142 | }; 143 | }; 144 | jQuery.browser = {}; 145 | jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; 146 | } 147 | 148 | /** 149 | * Small JavaScript module for the documentation. 150 | */ 151 | var Documentation = { 152 | 153 | init : function() { 154 | this.fixFirefoxAnchorBug(); 155 | this.highlightSearchWords(); 156 | this.initIndexTable(); 157 | if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { 158 | this.initOnKeyListeners(); 159 | } 160 | }, 161 | 162 | /** 163 | * i18n support 164 | */ 165 | TRANSLATIONS : {}, 166 | PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, 167 | LOCALE : 'unknown', 168 | 169 | // gettext and ngettext don't access this so that the functions 170 | // can safely bound to a different name (_ = Documentation.gettext) 171 | gettext : function(string) { 172 | var translated = Documentation.TRANSLATIONS[string]; 173 | if (typeof translated === 'undefined') 174 | return string; 175 | return (typeof translated === 'string') ? translated : translated[0]; 176 | }, 177 | 178 | ngettext : function(singular, plural, n) { 179 | var translated = Documentation.TRANSLATIONS[singular]; 180 | if (typeof translated === 'undefined') 181 | return (n == 1) ? singular : plural; 182 | return translated[Documentation.PLURALEXPR(n)]; 183 | }, 184 | 185 | addTranslations : function(catalog) { 186 | for (var key in catalog.messages) 187 | this.TRANSLATIONS[key] = catalog.messages[key]; 188 | this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); 189 | this.LOCALE = catalog.locale; 190 | }, 191 | 192 | /** 193 | * add context elements like header anchor links 194 | */ 195 | addContextElements : function() { 196 | $('div[id] > :header:first').each(function() { 197 | $('\u00B6'). 198 | attr('href', '#' + this.id). 199 | attr('title', _('Permalink to this headline')). 200 | appendTo(this); 201 | }); 202 | $('dt[id]').each(function() { 203 | $('\u00B6'). 204 | attr('href', '#' + this.id). 205 | attr('title', _('Permalink to this definition')). 206 | appendTo(this); 207 | }); 208 | }, 209 | 210 | /** 211 | * workaround a firefox stupidity 212 | * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 213 | */ 214 | fixFirefoxAnchorBug : function() { 215 | if (document.location.hash && $.browser.mozilla) 216 | window.setTimeout(function() { 217 | document.location.href += ''; 218 | }, 10); 219 | }, 220 | 221 | /** 222 | * highlight the search words provided in the url in the text 223 | */ 224 | highlightSearchWords : function() { 225 | var params = $.getQueryParameters(); 226 | var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; 227 | if (terms.length) { 228 | var body = $('div.body'); 229 | if (!body.length) { 230 | body = $('body'); 231 | } 232 | window.setTimeout(function() { 233 | $.each(terms, function() { 234 | body.highlightText(this.toLowerCase(), 'highlighted'); 235 | }); 236 | }, 10); 237 | $('

' + _('Hide Search Matches') + '

') 239 | .appendTo($('#searchbox')); 240 | } 241 | }, 242 | 243 | /** 244 | * init the domain index toggle buttons 245 | */ 246 | initIndexTable : function() { 247 | var togglers = $('img.toggler').click(function() { 248 | var src = $(this).attr('src'); 249 | var idnum = $(this).attr('id').substr(7); 250 | $('tr.cg-' + idnum).toggle(); 251 | if (src.substr(-9) === 'minus.png') 252 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 253 | else 254 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 255 | }).css('display', ''); 256 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 257 | togglers.click(); 258 | } 259 | }, 260 | 261 | /** 262 | * helper function to hide the search marks again 263 | */ 264 | hideSearchWords : function() { 265 | $('#searchbox .highlight-link').fadeOut(300); 266 | $('span.highlighted').removeClass('highlighted'); 267 | }, 268 | 269 | /** 270 | * make the url absolute 271 | */ 272 | makeURL : function(relativeURL) { 273 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 274 | }, 275 | 276 | /** 277 | * get the current relative url 278 | */ 279 | getCurrentURL : function() { 280 | var path = document.location.pathname; 281 | var parts = path.split(/\//); 282 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 283 | if (this === '..') 284 | parts.pop(); 285 | }); 286 | var url = parts.join('/'); 287 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 288 | }, 289 | 290 | initOnKeyListeners: function() { 291 | $(document).keydown(function(event) { 292 | var activeElementType = document.activeElement.tagName; 293 | // don't navigate when in search box, textarea, dropdown or button 294 | if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' 295 | && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey 296 | && !event.shiftKey) { 297 | switch (event.keyCode) { 298 | case 37: // left 299 | var prevHref = $('link[rel="prev"]').prop('href'); 300 | if (prevHref) { 301 | window.location.href = prevHref; 302 | return false; 303 | } 304 | case 39: // right 305 | var nextHref = $('link[rel="next"]').prop('href'); 306 | if (nextHref) { 307 | window.location.href = nextHref; 308 | return false; 309 | } 310 | } 311 | } 312 | }); 313 | } 314 | }; 315 | 316 | // quick alias for translations 317 | _ = Documentation.gettext; 318 | 319 | $(document).ready(function() { 320 | Documentation.init(); 321 | }); 322 | -------------------------------------------------------------------------------- /docs/_static/documentation_options.js: -------------------------------------------------------------------------------- 1 | var DOCUMENTATION_OPTIONS = { 2 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), 3 | VERSION: 'v0.9.2', 4 | LANGUAGE: 'None', 5 | COLLAPSE_INDEX: false, 6 | BUILDER: 'html', 7 | FILE_SUFFIX: '.html', 8 | LINK_SUFFIX: '.html', 9 | HAS_SOURCE: true, 10 | SOURCELINK_SUFFIX: '.txt', 11 | NAVIGATION_WITH_KEYS: false 12 | }; -------------------------------------------------------------------------------- /docs/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/_static/file.png -------------------------------------------------------------------------------- /docs/_static/font/fontello.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/_static/font/fontello.eot -------------------------------------------------------------------------------- /docs/_static/font/fontello.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Copyright (C) 2018 by original authors @ fontello.com 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/_static/font/fontello.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/_static/font/fontello.ttf -------------------------------------------------------------------------------- /docs/_static/font/fontello.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/_static/font/fontello.woff -------------------------------------------------------------------------------- /docs/_static/font/fontello.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/_static/font/fontello.woff2 -------------------------------------------------------------------------------- /docs/_static/js/theme.js: -------------------------------------------------------------------------------- 1 | $(document).ready(function(){ 2 | 3 | var $header = $('header'); 4 | var $body = $('body'); 5 | var $window = $(window); 6 | 7 | // scrolling variables 8 | var scrolling = false, 9 | previousTop = 0, 10 | currentTop = 0, 11 | scrollDelta = 10, 12 | scrollOffset = 150; 13 | 14 | // scroll event to show / hide header 15 | $window.on('scroll', function(){ 16 | if( !scrolling ) { 17 | scrolling = true; 18 | (!window.requestAnimationFrame) ? setTimeout(autoHideHeader, 250) : requestAnimationFrame(autoHideHeader); 19 | } 20 | }); 21 | 22 | function autoHideHeader() { 23 | var currentTop = $window.scrollTop(); 24 | var isNavOpen = $body.hasClass('nav-in'); 25 | if (!isNavOpen) { 26 | if (previousTop - currentTop > scrollDelta) { 27 | // if scrolling up... 28 | $header.removeClass('up'); 29 | } else if( currentTop - previousTop > scrollDelta && currentTop > scrollOffset) { 30 | // if scrolling down... 31 | $header.addClass('up'); 32 | } 33 | } 34 | previousTop = currentTop; 35 | scrolling = false; 36 | } 37 | 38 | // toggle sidebar 39 | $(document).on('click', '.site-nav-toggle, .site-nav a', function() { 40 | $body.toggleClass('nav-in'); 41 | }); 42 | 43 | // replace anchor scroll to offset the fixed header on mobile 44 | $("a[href^='#']").on('click', function(e) { 45 | // prevent default anchor click behavior 46 | e.preventDefault(); 47 | 48 | var width = $window.width(); 49 | var headerHeight = $header.outerHeight(); 50 | var mobileMaxWidth = 991; 51 | var offset = 0; 52 | 53 | if (width <= mobileMaxWidth) { 54 | offset = headerHeight + 10; 55 | } 56 | 57 | // animate scroll 58 | $('html, body').animate({ 59 | scrollTop: $(this.hash).offset().top - offset 60 | }, 200, function(){ 61 | }); 62 | }); 63 | 64 | // wrap tables so we can make responsive 65 | $("table.docutils:not(.field-list,.footnote,.citation)") 66 | .wrap("
"); 67 | 68 | }); -------------------------------------------------------------------------------- /docs/_static/language_data.js: -------------------------------------------------------------------------------- 1 | /* 2 | * language_data.js 3 | * ~~~~~~~~~~~~~~~~ 4 | * 5 | * This script contains the language-specific data used by searchtools.js, 6 | * namely the list of stopwords, stemmer, scorer and splitter. 7 | * 8 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. 9 | * :license: BSD, see LICENSE for details. 10 | * 11 | */ 12 | 13 | var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; 14 | 15 | 16 | /* Non-minified version is copied as a separate JS file, is available */ 17 | 18 | /** 19 | * Porter Stemmer 20 | */ 21 | var Stemmer = function() { 22 | 23 | var step2list = { 24 | ational: 'ate', 25 | tional: 'tion', 26 | enci: 'ence', 27 | anci: 'ance', 28 | izer: 'ize', 29 | bli: 'ble', 30 | alli: 'al', 31 | entli: 'ent', 32 | eli: 'e', 33 | ousli: 'ous', 34 | ization: 'ize', 35 | ation: 'ate', 36 | ator: 'ate', 37 | alism: 'al', 38 | iveness: 'ive', 39 | fulness: 'ful', 40 | ousness: 'ous', 41 | aliti: 'al', 42 | iviti: 'ive', 43 | biliti: 'ble', 44 | logi: 'log' 45 | }; 46 | 47 | var step3list = { 48 | icate: 'ic', 49 | ative: '', 50 | alize: 'al', 51 | iciti: 'ic', 52 | ical: 'ic', 53 | ful: '', 54 | ness: '' 55 | }; 56 | 57 | var c = "[^aeiou]"; // consonant 58 | var v = "[aeiouy]"; // vowel 59 | var C = c + "[^aeiouy]*"; // consonant sequence 60 | var V = v + "[aeiou]*"; // vowel sequence 61 | 62 | var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 63 | var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 64 | var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 65 | var s_v = "^(" + C + ")?" + v; // vowel in stem 66 | 67 | this.stemWord = function (w) { 68 | var stem; 69 | var suffix; 70 | var firstch; 71 | var origword = w; 72 | 73 | if (w.length < 3) 74 | return w; 75 | 76 | var re; 77 | var re2; 78 | var re3; 79 | var re4; 80 | 81 | firstch = w.substr(0,1); 82 | if (firstch == "y") 83 | w = firstch.toUpperCase() + w.substr(1); 84 | 85 | // Step 1a 86 | re = /^(.+?)(ss|i)es$/; 87 | re2 = /^(.+?)([^s])s$/; 88 | 89 | if (re.test(w)) 90 | w = w.replace(re,"$1$2"); 91 | else if (re2.test(w)) 92 | w = w.replace(re2,"$1$2"); 93 | 94 | // Step 1b 95 | re = /^(.+?)eed$/; 96 | re2 = /^(.+?)(ed|ing)$/; 97 | if (re.test(w)) { 98 | var fp = re.exec(w); 99 | re = new RegExp(mgr0); 100 | if (re.test(fp[1])) { 101 | re = /.$/; 102 | w = w.replace(re,""); 103 | } 104 | } 105 | else if (re2.test(w)) { 106 | var fp = re2.exec(w); 107 | stem = fp[1]; 108 | re2 = new RegExp(s_v); 109 | if (re2.test(stem)) { 110 | w = stem; 111 | re2 = /(at|bl|iz)$/; 112 | re3 = new RegExp("([^aeiouylsz])\\1$"); 113 | re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); 114 | if (re2.test(w)) 115 | w = w + "e"; 116 | else if (re3.test(w)) { 117 | re = /.$/; 118 | w = w.replace(re,""); 119 | } 120 | else if (re4.test(w)) 121 | w = w + "e"; 122 | } 123 | } 124 | 125 | // Step 1c 126 | re = /^(.+?)y$/; 127 | if (re.test(w)) { 128 | var fp = re.exec(w); 129 | stem = fp[1]; 130 | re = new RegExp(s_v); 131 | if (re.test(stem)) 132 | w = stem + "i"; 133 | } 134 | 135 | // Step 2 136 | re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; 137 | if (re.test(w)) { 138 | var fp = re.exec(w); 139 | stem = fp[1]; 140 | suffix = fp[2]; 141 | re = new RegExp(mgr0); 142 | if (re.test(stem)) 143 | w = stem + step2list[suffix]; 144 | } 145 | 146 | // Step 3 147 | re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; 148 | if (re.test(w)) { 149 | var fp = re.exec(w); 150 | stem = fp[1]; 151 | suffix = fp[2]; 152 | re = new RegExp(mgr0); 153 | if (re.test(stem)) 154 | w = stem + step3list[suffix]; 155 | } 156 | 157 | // Step 4 158 | re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; 159 | re2 = /^(.+?)(s|t)(ion)$/; 160 | if (re.test(w)) { 161 | var fp = re.exec(w); 162 | stem = fp[1]; 163 | re = new RegExp(mgr1); 164 | if (re.test(stem)) 165 | w = stem; 166 | } 167 | else if (re2.test(w)) { 168 | var fp = re2.exec(w); 169 | stem = fp[1] + fp[2]; 170 | re2 = new RegExp(mgr1); 171 | if (re2.test(stem)) 172 | w = stem; 173 | } 174 | 175 | // Step 5 176 | re = /^(.+?)e$/; 177 | if (re.test(w)) { 178 | var fp = re.exec(w); 179 | stem = fp[1]; 180 | re = new RegExp(mgr1); 181 | re2 = new RegExp(meq1); 182 | re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); 183 | if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) 184 | w = stem; 185 | } 186 | re = /ll$/; 187 | re2 = new RegExp(mgr1); 188 | if (re.test(w) && re2.test(w)) { 189 | re = /.$/; 190 | w = w.replace(re,""); 191 | } 192 | 193 | // and turn initial Y back to y 194 | if (firstch == "y") 195 | w = firstch.toLowerCase() + w.substr(1); 196 | return w; 197 | } 198 | } 199 | 200 | 201 | 202 | 203 | var splitChars = (function() { 204 | var result = {}; 205 | var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, 206 | 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, 207 | 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, 208 | 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, 209 | 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, 210 | 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, 211 | 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, 212 | 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, 213 | 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, 214 | 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; 215 | var i, j, start, end; 216 | for (i = 0; i < singles.length; i++) { 217 | result[singles[i]] = true; 218 | } 219 | var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], 220 | [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], 221 | [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], 222 | [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], 223 | [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], 224 | [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], 225 | [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], 226 | [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], 227 | [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], 228 | [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], 229 | [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], 230 | [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], 231 | [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], 232 | [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], 233 | [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], 234 | [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], 235 | [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], 236 | [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], 237 | [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], 238 | [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], 239 | [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], 240 | [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], 241 | [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], 242 | [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], 243 | [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], 244 | [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], 245 | [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], 246 | [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], 247 | [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], 248 | [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], 249 | [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], 250 | [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], 251 | [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], 252 | [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], 253 | [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], 254 | [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], 255 | [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], 256 | [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], 257 | [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], 258 | [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], 259 | [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], 260 | [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], 261 | [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], 262 | [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], 263 | [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], 264 | [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], 265 | [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], 266 | [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], 267 | [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; 268 | for (i = 0; i < ranges.length; i++) { 269 | start = ranges[i][0]; 270 | end = ranges[i][1]; 271 | for (j = start; j <= end; j++) { 272 | result[j] = true; 273 | } 274 | } 275 | return result; 276 | })(); 277 | 278 | function splitQuery(query) { 279 | var result = []; 280 | var start = -1; 281 | for (var i = 0; i < query.length; i++) { 282 | if (splitChars[query.charCodeAt(i)]) { 283 | if (start !== -1) { 284 | result.push(query.slice(start, i)); 285 | start = -1; 286 | } 287 | } else if (start === -1) { 288 | start = i; 289 | } 290 | } 291 | if (start !== -1) { 292 | result.push(query.slice(start)); 293 | } 294 | return result; 295 | } 296 | 297 | 298 | -------------------------------------------------------------------------------- /docs/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/_static/minus.png -------------------------------------------------------------------------------- /docs/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/naresh97/OpenProfinet/7ed53def513c9fec040ccf35a517f1b2c89c7688/docs/_static/plus.png -------------------------------------------------------------------------------- /docs/_static/pygments.css: -------------------------------------------------------------------------------- 1 | .highlight .hll { background-color: #ffffcc } 2 | .highlight { background: #f8f8f8; } 3 | .highlight .c { color: #408080; font-style: italic } /* Comment */ 4 | .highlight .err { border: 1px solid #FF0000 } /* Error */ 5 | .highlight .k { color: #008000; font-weight: bold } /* Keyword */ 6 | .highlight .o { color: #666666 } /* Operator */ 7 | .highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */ 8 | .highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */ 9 | .highlight .cp { color: #BC7A00 } /* Comment.Preproc */ 10 | .highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ 11 | .highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */ 12 | .highlight .cs { color: #408080; font-style: italic } /* Comment.Special */ 13 | .highlight .gd { color: #A00000 } /* Generic.Deleted */ 14 | .highlight .ge { font-style: italic } /* Generic.Emph */ 15 | .highlight .gr { color: #FF0000 } /* Generic.Error */ 16 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 17 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 18 | .highlight .go { color: #888888 } /* Generic.Output */ 19 | .highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ 20 | .highlight .gs { font-weight: bold } /* Generic.Strong */ 21 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 22 | .highlight .gt { color: #0044DD } /* Generic.Traceback */ 23 | .highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ 24 | .highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ 25 | .highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ 26 | .highlight .kp { color: #008000 } /* Keyword.Pseudo */ 27 | .highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ 28 | .highlight .kt { color: #B00040 } /* Keyword.Type */ 29 | .highlight .m { color: #666666 } /* Literal.Number */ 30 | .highlight .s { color: #BA2121 } /* Literal.String */ 31 | .highlight .na { color: #7D9029 } /* Name.Attribute */ 32 | .highlight .nb { color: #008000 } /* Name.Builtin */ 33 | .highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ 34 | .highlight .no { color: #880000 } /* Name.Constant */ 35 | .highlight .nd { color: #AA22FF } /* Name.Decorator */ 36 | .highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */ 37 | .highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */ 38 | .highlight .nf { color: #0000FF } /* Name.Function */ 39 | .highlight .nl { color: #A0A000 } /* Name.Label */ 40 | .highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ 41 | .highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ 42 | .highlight .nv { color: #19177C } /* Name.Variable */ 43 | .highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ 44 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */ 45 | .highlight .mb { color: #666666 } /* Literal.Number.Bin */ 46 | .highlight .mf { color: #666666 } /* Literal.Number.Float */ 47 | .highlight .mh { color: #666666 } /* Literal.Number.Hex */ 48 | .highlight .mi { color: #666666 } /* Literal.Number.Integer */ 49 | .highlight .mo { color: #666666 } /* Literal.Number.Oct */ 50 | .highlight .sa { color: #BA2121 } /* Literal.String.Affix */ 51 | .highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ 52 | .highlight .sc { color: #BA2121 } /* Literal.String.Char */ 53 | .highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ 54 | .highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ 55 | .highlight .s2 { color: #BA2121 } /* Literal.String.Double */ 56 | .highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ 57 | .highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ 58 | .highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ 59 | .highlight .sx { color: #008000 } /* Literal.String.Other */ 60 | .highlight .sr { color: #BB6688 } /* Literal.String.Regex */ 61 | .highlight .s1 { color: #BA2121 } /* Literal.String.Single */ 62 | .highlight .ss { color: #19177C } /* Literal.String.Symbol */ 63 | .highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ 64 | .highlight .fm { color: #0000FF } /* Name.Function.Magic */ 65 | .highlight .vc { color: #19177C } /* Name.Variable.Class */ 66 | .highlight .vg { color: #19177C } /* Name.Variable.Global */ 67 | .highlight .vi { color: #19177C } /* Name.Variable.Instance */ 68 | .highlight .vm { color: #19177C } /* Name.Variable.Magic */ 69 | .highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /docs/_static/searchtools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * searchtools.js 3 | * ~~~~~~~~~~~~~~~~ 4 | * 5 | * Sphinx JavaScript utilities for the full-text search. 6 | * 7 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | if (!Scorer) { 13 | /** 14 | * Simple result scoring code. 15 | */ 16 | var Scorer = { 17 | // Implement the following function to further tweak the score for each result 18 | // The function takes a result array [filename, title, anchor, descr, score] 19 | // and returns the new score. 20 | /* 21 | score: function(result) { 22 | return result[4]; 23 | }, 24 | */ 25 | 26 | // query matches the full name of an object 27 | objNameMatch: 11, 28 | // or matches in the last dotted part of the object name 29 | objPartialMatch: 6, 30 | // Additive scores depending on the priority of the object 31 | objPrio: {0: 15, // used to be importantResults 32 | 1: 5, // used to be objectResults 33 | 2: -5}, // used to be unimportantResults 34 | // Used when the priority is not in the mapping. 35 | objPrioDefault: 0, 36 | 37 | // query found in title 38 | title: 15, 39 | partialTitle: 7, 40 | // query found in terms 41 | term: 5, 42 | partialTerm: 2 43 | }; 44 | } 45 | 46 | if (!splitQuery) { 47 | function splitQuery(query) { 48 | return query.split(/\s+/); 49 | } 50 | } 51 | 52 | /** 53 | * Search Module 54 | */ 55 | var Search = { 56 | 57 | _index : null, 58 | _queued_query : null, 59 | _pulse_status : -1, 60 | 61 | htmlToText : function(htmlString) { 62 | var virtualDocument = document.implementation.createHTMLDocument('virtual'); 63 | var htmlElement = $(htmlString, virtualDocument); 64 | htmlElement.find('.headerlink').remove(); 65 | docContent = htmlElement.find('[role=main]')[0]; 66 | if(docContent === undefined) { 67 | console.warn("Content block not found. Sphinx search tries to obtain it " + 68 | "via '[role=main]'. Could you check your theme or template."); 69 | return ""; 70 | } 71 | return docContent.textContent || docContent.innerText; 72 | }, 73 | 74 | init : function() { 75 | var params = $.getQueryParameters(); 76 | if (params.q) { 77 | var query = params.q[0]; 78 | $('input[name="q"]')[0].value = query; 79 | this.performSearch(query); 80 | } 81 | }, 82 | 83 | loadIndex : function(url) { 84 | $.ajax({type: "GET", url: url, data: null, 85 | dataType: "script", cache: true, 86 | complete: function(jqxhr, textstatus) { 87 | if (textstatus != "success") { 88 | document.getElementById("searchindexloader").src = url; 89 | } 90 | }}); 91 | }, 92 | 93 | setIndex : function(index) { 94 | var q; 95 | this._index = index; 96 | if ((q = this._queued_query) !== null) { 97 | this._queued_query = null; 98 | Search.query(q); 99 | } 100 | }, 101 | 102 | hasIndex : function() { 103 | return this._index !== null; 104 | }, 105 | 106 | deferQuery : function(query) { 107 | this._queued_query = query; 108 | }, 109 | 110 | stopPulse : function() { 111 | this._pulse_status = 0; 112 | }, 113 | 114 | startPulse : function() { 115 | if (this._pulse_status >= 0) 116 | return; 117 | function pulse() { 118 | var i; 119 | Search._pulse_status = (Search._pulse_status + 1) % 4; 120 | var dotString = ''; 121 | for (i = 0; i < Search._pulse_status; i++) 122 | dotString += '.'; 123 | Search.dots.text(dotString); 124 | if (Search._pulse_status > -1) 125 | window.setTimeout(pulse, 500); 126 | } 127 | pulse(); 128 | }, 129 | 130 | /** 131 | * perform a search for something (or wait until index is loaded) 132 | */ 133 | performSearch : function(query) { 134 | // create the required interface elements 135 | this.out = $('#search-results'); 136 | this.title = $('

' + _('Searching') + '

').appendTo(this.out); 137 | this.dots = $('').appendTo(this.title); 138 | this.status = $('

 

').appendTo(this.out); 139 | this.output = $('