2022.6 #88
@ -23,7 +23,7 @@
|
|||||||
"set-pip-urls": "cpl run set-pip-urls $ARGS; echo '';",
|
"set-pip-urls": "cpl run set-pip-urls $ARGS; echo '';",
|
||||||
|
|
||||||
"docs-build": "echo 'Build Documentation'; cd docs/; sphinx-apidoc -o source/ ../src/cpl_core; sphinx-apidoc -o source/ ../src/cpl_query; make clean; make html; rm source/cpl_query.tests.rst;",
|
"docs-build": "echo 'Build Documentation'; cd docs/; sphinx-apidoc -o source/ ../src/cpl_core; sphinx-apidoc -o source/ ../src/cpl_query; make clean; make html; rm source/cpl_query.tests.rst;",
|
||||||
"db": "cpl build-docs",
|
"db": "cpl docs-build",
|
||||||
"docs-open": "xdg-open $PWD/docs/build/html/index.html &",
|
"docs-open": "xdg-open $PWD/docs/build/html/index.html &",
|
||||||
"do": "cpl docs-open",
|
"do": "cpl docs-open",
|
||||||
|
|
||||||
|
BIN
docs/build/doctrees/cli.add.doctree
vendored
BIN
docs/build/doctrees/cli.add.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.build.doctree
vendored
BIN
docs/build/doctrees/cli.build.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.generate.doctree
vendored
BIN
docs/build/doctrees/cli.generate.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.help.doctree
vendored
BIN
docs/build/doctrees/cli.help.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.install.doctree
vendored
BIN
docs/build/doctrees/cli.install.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.new.doctree
vendored
BIN
docs/build/doctrees/cli.new.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.overview.doctree
vendored
BIN
docs/build/doctrees/cli.overview.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.publish.doctree
vendored
BIN
docs/build/doctrees/cli.publish.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.remove.doctree
vendored
BIN
docs/build/doctrees/cli.remove.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.start.doctree
vendored
BIN
docs/build/doctrees/cli.start.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.uninstall.doctree
vendored
BIN
docs/build/doctrees/cli.uninstall.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.update.doctree
vendored
BIN
docs/build/doctrees/cli.update.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.version.doctree
vendored
BIN
docs/build/doctrees/cli.version.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/contributing.doctree
vendored
BIN
docs/build/doctrees/contributing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.configuration.doctree
vendored
BIN
docs/build/doctrees/cpl_core.configuration.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.console.doctree
vendored
BIN
docs/build/doctrees/cpl_core.console.doctree
vendored
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.doctree
vendored
BIN
docs/build/doctrees/cpl_core.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.environment.doctree
vendored
BIN
docs/build/doctrees/cpl_core.environment.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.logging.doctree
vendored
BIN
docs/build/doctrees/cpl_core.logging.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.mailing.doctree
vendored
BIN
docs/build/doctrees/cpl_core.mailing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.time.doctree
vendored
BIN
docs/build/doctrees/cpl_core.time.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.utils.doctree
vendored
BIN
docs/build/doctrees/cpl_core.utils.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.doctree
vendored
BIN
docs/build/doctrees/cpl_query.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.exceptions.doctree
vendored
BIN
docs/build/doctrees/cpl_query.exceptions.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.tests.doctree
vendored
BIN
docs/build/doctrees/cpl_query.tests.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/build/doctrees/getting_started.doctree
vendored
BIN
docs/build/doctrees/getting_started.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/index.doctree
vendored
BIN
docs/build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/introduction.doctree
vendored
BIN
docs/build/doctrees/introduction.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/modules.doctree
vendored
BIN
docs/build/doctrees/modules.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/quickstart.doctree
vendored
BIN
docs/build/doctrees/quickstart.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/setup.doctree
vendored
BIN
docs/build/doctrees/setup.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.appsettings.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.appsettings.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/tutorials.console-arguments.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.console-arguments.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/tutorials.console.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.console.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/tutorials.create-startup.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.create-startup.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/tutorials.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/tutorials.extend-application.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.extend-application.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/tutorials.extend-startup.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.extend-startup.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/tutorials.logging.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.logging.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/tutorials.mail.doctree
vendored
Normal file
BIN
docs/build/doctrees/tutorials.mail.doctree
vendored
Normal file
Binary file not shown.
2
docs/build/html/.buildinfo
vendored
2
docs/build/html/.buildinfo
vendored
@ -1,4 +1,4 @@
|
|||||||
# Sphinx build info version 1
|
# Sphinx build info version 1
|
||||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||||
config: 8170277cf12e5442e6180427108a8adf
|
config: 9ea51a00cf3559575c97b7efd7a002e5
|
||||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
|
14
docs/build/html/_sources/cli.add.md.txt
vendored
14
docs/build/html/_sources/cli.add.md.txt
vendored
@ -19,7 +19,13 @@ If you call the command in a CPL workspace, you can use the project names. Other
|
|||||||
|
|
||||||
## Arguments
|
## Arguments
|
||||||
|
|
||||||
| Argument | Description | Value type |
|
| Argument | Description | Value type |
|
||||||
| ------------------------- |:---------------------------------------------------------------:|:----------------:|
|
|------------------------|:----------------------------------------------------------:|:----------:|
|
||||||
| ```<source-project>``` | Name of the project to which the reference has to be added | ```str```
|
| ```<source-project>``` | Name of the project to which the reference has to be added | ```str``` |
|
||||||
| ```<target-project>``` | Name of the project to be referenced | ```str```
|
| ```<target-project>``` | Name of the project to be referenced | ```str``` |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
|
||||||
|
| Argument | Description |
|
||||||
|
|------------------|:------------------------------------------:|
|
||||||
|
| ```--simulate``` | Specifies whether the command is simulated |
|
||||||
|
19
docs/build/html/_sources/cli.generate.md.txt
vendored
19
docs/build/html/_sources/cli.generate.md.txt
vendored
@ -25,11 +25,14 @@ Generates files based on a schematic.
|
|||||||
|
|
||||||
## Schematics
|
## Schematics
|
||||||
|
|
||||||
| Schematic | Description | Arguments |
|
| Schematic | Description | Arguments |
|
||||||
| ----------------- |:-------------------:|:----------------:|
|
|-----------------|:-------------------------------------:|:------------:|
|
||||||
| ```abc``` | Abstract base class | ```<name>```
|
| ```abc``` | Abstract base class | ```<name>``` |
|
||||||
| ```class``` | Class | ```<name>```
|
| ```class``` | Class | ```<name>``` |
|
||||||
| ```enum``` | Enum class | ```<name>```
|
| ```enum``` | Enum class | ```<name>``` |
|
||||||
| ```service``` | Service class | ```<name>```
|
| ```pipe``` | Pipe class | ```<name>``` |
|
||||||
| ```settings``` | [Configmodel](cpl_core.configuration) | ```<name>```
|
| ```service``` | Service class | ```<name>``` |
|
||||||
| ```thread``` | Thread class | ```<name>```
|
| ```settings``` | [Configmodel](cpl_core.configuration) | ```<name>``` |
|
||||||
|
| ```test``` | Test class | ```<name>``` |
|
||||||
|
| ```thread``` | Thread class | ```<name>``` |
|
||||||
|
| ```validator``` | Validator class | ```<name>``` |
|
||||||
|
14
docs/build/html/_sources/cli.install.md.txt
vendored
14
docs/build/html/_sources/cli.install.md.txt
vendored
@ -18,6 +18,14 @@ Without given package it will install the depedencies of the CPL project your in
|
|||||||
|
|
||||||
## Arguments
|
## Arguments
|
||||||
|
|
||||||
| Argument | Description | Value type |
|
| Argument | Description | Value type |
|
||||||
| ----------------- |:-----------------------------:|:-------------:|
|
|-----------------|:----------------------:|:----------:|
|
||||||
| ```<package>``` | The package to install | ```str``` |
|
| ```<package>``` | The package to install | ```str``` |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
|
||||||
|
| Argument | Description |
|
||||||
|
|------------------|:----------------------------------------------------:|
|
||||||
|
| ```--dev``` | Specifies whether the command is in development mode |
|
||||||
|
| ```--virtual``` | Specifies whether the command is virtual mode |
|
||||||
|
| ```--simulate``` | Specifies whether the command is simulated |
|
||||||
|
27
docs/build/html/_sources/cli.new.md.txt
vendored
27
docs/build/html/_sources/cli.new.md.txt
vendored
@ -18,14 +18,25 @@ Generates a workspace and initial project or add a project to workspace.
|
|||||||
|
|
||||||
If the command is running in a CPL workspace, it will add the new project to the workspace.
|
If the command is running in a CPL workspace, it will add the new project to the workspace.
|
||||||
|
|
||||||
| Argument | Description | Value type |
|
| Argument | Description | Value type |
|
||||||
| ----------------- |:-----------------------------------------------------:|:-------------:|
|
|--------------|:----------------------------------------------------:|:----------:|
|
||||||
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
||||||
| ```<name>``` | The name of the project | ```str``` |
|
| ```<name>``` | The name of the project | ```str``` |
|
||||||
|
|
||||||
## Project types
|
## Project types
|
||||||
|
|
||||||
| Project type | Description |
|
| Project type | Description |
|
||||||
| ----------------- |:-----------------------------:|
|
|---------------|:----------------------------:|
|
||||||
| ```console``` | A simple console application |
|
| ```console``` | A simple console application |
|
||||||
| ```library``` | A package |
|
| ```library``` | A package |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
|
||||||
|
| Argument | Description |
|
||||||
|
|---------------------------|:-------------------------------------------:|
|
||||||
|
| ```--async``` | Specifies whether async is used |
|
||||||
|
| ```--application-base``` | Specifies whether application base is used |
|
||||||
|
| ```--startup``` | Specifies whether startup is used |
|
||||||
|
| ```--service-providing``` | Specifies whether service-providing is used |
|
||||||
|
| ```--nothing``` | Specifies whether nothing is used |
|
||||||
|
| ```--venv``` | Specifies whether venv is used |
|
||||||
|
12
docs/build/html/_sources/cli.remove.md.txt
vendored
12
docs/build/html/_sources/cli.remove.md.txt
vendored
@ -19,6 +19,12 @@ If you call the command in a CPL workspace, you can use the project names. Other
|
|||||||
|
|
||||||
## Arguments
|
## Arguments
|
||||||
|
|
||||||
| Argument | Description | Value type |
|
| Argument | Description | Value type |
|
||||||
| ------------------------- |:-------------------------------------:|:----------------:|
|
|-----------------|:---------------------------------:|:----------:|
|
||||||
| ```<project>``` | The name of the project to delete | ```str```
|
| ```<project>``` | The name of the project to delete | ```str``` |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
|
||||||
|
| Argument | Description |
|
||||||
|
|------------------|:----------------------------------------------------:|
|
||||||
|
| ```--simulate``` | Specifies whether the command is simulated |
|
||||||
|
14
docs/build/html/_sources/cli.uninstall.md.txt
vendored
14
docs/build/html/_sources/cli.uninstall.md.txt
vendored
@ -17,6 +17,14 @@ Uninstall given package from project via pip.
|
|||||||
|
|
||||||
## Arguments
|
## Arguments
|
||||||
|
|
||||||
| Argument | Description | Value type |
|
| Argument | Description | Value type |
|
||||||
| ----------------- |:-----------------------------:|:-------------:|
|
|-----------------|:------------------------:|:----------:|
|
||||||
| ```<package>``` | The package to uninstall | ```str``` |
|
| ```<package>``` | The package to uninstall | ```str``` |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
|
||||||
|
| Argument | Description |
|
||||||
|
|------------------|:----------------------------------------------------:|
|
||||||
|
| ```--dev``` | Specifies whether the command is in development mode |
|
||||||
|
| ```--virtual``` | Specifies whether the command is virtual mode |
|
||||||
|
| ```--simulate``` | Specifies whether the command is simulated |
|
||||||
|
6
docs/build/html/_sources/cli.update.md.txt
vendored
6
docs/build/html/_sources/cli.update.md.txt
vendored
@ -5,3 +5,9 @@ Updates the CPL and project dependencies.
|
|||||||
cpl **update** <br>
|
cpl **update** <br>
|
||||||
cpl **u** <br>
|
cpl **u** <br>
|
||||||
cpl **U**
|
cpl **U**
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
|
||||||
|
| Argument | Description |
|
||||||
|
|------------------|:----------------------------------------------------:|
|
||||||
|
| ```--simulate``` | Specifies whether the command is simulated |
|
||||||
|
77
docs/build/html/_sources/cpl_core.pipes.rst.txt
vendored
Normal file
77
docs/build/html/_sources/cpl_core.pipes.rst.txt
vendored
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
cpl\_core.pipes
|
||||||
|
=======================
|
||||||
|
|
||||||
|
Submodules
|
||||||
|
----------
|
||||||
|
|
||||||
|
cpl\_core.pipes.bool\_pipe module
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_core.pipes.bool_pipe
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_core.pipes.first\_char\_to\_lower\_pipe module
|
||||||
|
---------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_core.pipes.first_char_to_lower_pipe
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_core.pipes.first\_to\_upper\_pipe module
|
||||||
|
---------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_core.pipes.first_to_upper_pipe
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_core.pipes.ip\_address\_pipe module
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_core.pipes.ip_address_pipe
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_core.pipes.pipe\_abc module
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_core.pipes.pipe_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_core.pipes.to\_camel\_case\_pipe module
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_core.pipes.to_camel_case_pipe
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_core.pipes.to\_snake\_case\_pipe module
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_core.pipes.to_snake_case_pipe
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_core.pipes.version\_pipe module
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_core.pipes.version_pipe
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
Module contents
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_core.pipes
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
1
docs/build/html/_sources/cpl_core.rst.txt
vendored
1
docs/build/html/_sources/cpl_core.rst.txt
vendored
@ -12,5 +12,6 @@ API Reference
|
|||||||
cpl_core.environment
|
cpl_core.environment
|
||||||
cpl_core.logging
|
cpl_core.logging
|
||||||
cpl_core.mailing
|
cpl_core.mailing
|
||||||
|
cpl_core.pipes
|
||||||
cpl_core.time
|
cpl_core.time
|
||||||
cpl_core.utils
|
cpl_core.utils
|
||||||
|
45
docs/build/html/_sources/cpl_query.tests.rst.txt
vendored
45
docs/build/html/_sources/cpl_query.tests.rst.txt
vendored
@ -1,45 +0,0 @@
|
|||||||
cpl\_query.tests package
|
|
||||||
========================
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
cpl\_query.tests.iterable\_test module
|
|
||||||
--------------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.tests.iterable_test
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
cpl\_query.tests.models module
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.tests.models
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
cpl\_query.tests.query\_test module
|
|
||||||
-----------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.tests.query_test
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
cpl\_query.tests.tester module
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.tests.tester
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.tests
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
@ -6,4 +6,5 @@ Getting started
|
|||||||
|
|
||||||
quickstart
|
quickstart
|
||||||
setup
|
setup
|
||||||
|
tutorials
|
||||||
|
|
||||||
|
47
docs/build/html/_sources/introduction.md.txt
vendored
47
docs/build/html/_sources/introduction.md.txt
vendored
@ -4,6 +4,53 @@ The Common Python Library (CPL) is a package for python and a development platfo
|
|||||||
|
|
||||||
This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.
|
This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.
|
||||||
|
|
||||||
|
## Feature overview
|
||||||
|
|
||||||
|
- Expandle
|
||||||
|
- Application base
|
||||||
|
- Standardized application classes
|
||||||
|
- Application object builder
|
||||||
|
- Application extension classes
|
||||||
|
- Startup classes
|
||||||
|
- Startup extension classes
|
||||||
|
- Configuration
|
||||||
|
- Configure via object mapped JSON
|
||||||
|
- Console argument handling
|
||||||
|
- Console class for in and output
|
||||||
|
- Banner
|
||||||
|
- Spinner
|
||||||
|
- Options (menu)
|
||||||
|
- Table
|
||||||
|
- Write
|
||||||
|
- Write_at
|
||||||
|
- Write_line
|
||||||
|
- Write_line_at
|
||||||
|
- Dependency injection
|
||||||
|
- Service lifetimes: singleton, scoped and transient
|
||||||
|
- Providing of application environment
|
||||||
|
- Environment (development, staging, testing, production)
|
||||||
|
- Appname
|
||||||
|
- Customer
|
||||||
|
- Hostname
|
||||||
|
- Runtime directory
|
||||||
|
- Working directory
|
||||||
|
- Logging
|
||||||
|
- Standardized logger
|
||||||
|
- Log-level (FATAL, ERROR, WARN, INFO, DEBUG & TRACE)
|
||||||
|
- Mail handling
|
||||||
|
- Send mails
|
||||||
|
- Pipe classes
|
||||||
|
- Convert input
|
||||||
|
- Utils
|
||||||
|
- Credential manager
|
||||||
|
- Encryption via BASE64
|
||||||
|
- PIP wrapper class based on subprocess
|
||||||
|
- Run pip commands
|
||||||
|
- String converter to different variants
|
||||||
|
- to_lower_case
|
||||||
|
- to_camel_case
|
||||||
|
- ...
|
||||||
|
|
||||||
## Explore
|
## Explore
|
||||||
|
|
||||||
- [Getting started](quickstart)
|
- [Getting started](quickstart)
|
||||||
|
1
docs/build/html/_sources/tutorials.appsettings.md.txt
vendored
Normal file
1
docs/build/html/_sources/tutorials.appsettings.md.txt
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Using appsettings.json
|
1
docs/build/html/_sources/tutorials.console-arguments.md.txt
vendored
Normal file
1
docs/build/html/_sources/tutorials.console-arguments.md.txt
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Handle console arguments
|
1
docs/build/html/_sources/tutorials.console.md.txt
vendored
Normal file
1
docs/build/html/_sources/tutorials.console.md.txt
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Use cpl_core.console.Console
|
1
docs/build/html/_sources/tutorials.create-startup.md.txt
vendored
Normal file
1
docs/build/html/_sources/tutorials.create-startup.md.txt
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Create startup class
|
1
docs/build/html/_sources/tutorials.extend-application.md.txt
vendored
Normal file
1
docs/build/html/_sources/tutorials.extend-application.md.txt
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Extend application
|
1
docs/build/html/_sources/tutorials.extend-startup.md.txt
vendored
Normal file
1
docs/build/html/_sources/tutorials.extend-startup.md.txt
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Extend startup
|
1
docs/build/html/_sources/tutorials.logging.md.txt
vendored
Normal file
1
docs/build/html/_sources/tutorials.logging.md.txt
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Use builtin logger
|
1
docs/build/html/_sources/tutorials.mail.md.txt
vendored
Normal file
1
docs/build/html/_sources/tutorials.mail.md.txt
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Send mails
|
14
docs/build/html/_sources/tutorials.rst.txt
vendored
Normal file
14
docs/build/html/_sources/tutorials.rst.txt
vendored
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
Tutorials
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
tutorials.extend-application
|
||||||
|
tutorials.create-startup
|
||||||
|
tutorials.extend-startup
|
||||||
|
tutorials.appsettings
|
||||||
|
tutorials.console-arguments
|
||||||
|
tutorials.console
|
||||||
|
tutorials.logging
|
||||||
|
tutorials.mail
|
134
docs/build/html/_static/_sphinx_javascript_frameworks_compat.js
vendored
Normal file
134
docs/build/html/_static/_sphinx_javascript_frameworks_compat.js
vendored
Normal file
@ -0,0 +1,134 @@
|
|||||||
|
/*
|
||||||
|
* _sphinx_javascript_frameworks_compat.js
|
||||||
|
* ~~~~~~~~~~
|
||||||
|
*
|
||||||
|
* Compatability shim for jQuery and underscores.js.
|
||||||
|
*
|
||||||
|
* WILL BE REMOVED IN Sphinx 6.0
|
||||||
|
* xref RemovedInSphinx60Warning
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* select a different prefix for underscore
|
||||||
|
*/
|
||||||
|
$u = _.noConflict();
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* small helper function to urldecode strings
|
||||||
|
*
|
||||||
|
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
||||||
|
*/
|
||||||
|
jQuery.urldecode = function(x) {
|
||||||
|
if (!x) {
|
||||||
|
return x
|
||||||
|
}
|
||||||
|
return decodeURIComponent(x.replace(/\+/g, ' '));
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* small helper function to urlencode strings
|
||||||
|
*/
|
||||||
|
jQuery.urlencode = encodeURIComponent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function returns the parsed url parameters of the
|
||||||
|
* current request. Multiple values per key are supported,
|
||||||
|
* it will always return arrays of strings for the value parts.
|
||||||
|
*/
|
||||||
|
jQuery.getQueryParameters = function(s) {
|
||||||
|
if (typeof s === 'undefined')
|
||||||
|
s = document.location.search;
|
||||||
|
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||||
|
var result = {};
|
||||||
|
for (var i = 0; i < parts.length; i++) {
|
||||||
|
var tmp = parts[i].split('=', 2);
|
||||||
|
var key = jQuery.urldecode(tmp[0]);
|
||||||
|
var value = jQuery.urldecode(tmp[1]);
|
||||||
|
if (key in result)
|
||||||
|
result[key].push(value);
|
||||||
|
else
|
||||||
|
result[key] = [value];
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* highlight a given string on a jquery object by wrapping it in
|
||||||
|
* span elements with the given class name.
|
||||||
|
*/
|
||||||
|
jQuery.fn.highlightText = function(text, className) {
|
||||||
|
function highlight(node, addItems) {
|
||||||
|
if (node.nodeType === 3) {
|
||||||
|
var val = node.nodeValue;
|
||||||
|
var pos = val.toLowerCase().indexOf(text);
|
||||||
|
if (pos >= 0 &&
|
||||||
|
!jQuery(node.parentNode).hasClass(className) &&
|
||||||
|
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
||||||
|
var span;
|
||||||
|
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||||
|
if (isInSVG) {
|
||||||
|
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||||
|
} else {
|
||||||
|
span = document.createElement("span");
|
||||||
|
span.className = className;
|
||||||
|
}
|
||||||
|
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||||
|
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||||
|
document.createTextNode(val.substr(pos + text.length)),
|
||||||
|
node.nextSibling));
|
||||||
|
node.nodeValue = val.substr(0, pos);
|
||||||
|
if (isInSVG) {
|
||||||
|
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||||
|
var bbox = node.parentElement.getBBox();
|
||||||
|
rect.x.baseVal.value = bbox.x;
|
||||||
|
rect.y.baseVal.value = bbox.y;
|
||||||
|
rect.width.baseVal.value = bbox.width;
|
||||||
|
rect.height.baseVal.value = bbox.height;
|
||||||
|
rect.setAttribute('class', className);
|
||||||
|
addItems.push({
|
||||||
|
"parent": node.parentNode,
|
||||||
|
"target": rect});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (!jQuery(node).is("button, select, textarea")) {
|
||||||
|
jQuery.each(node.childNodes, function() {
|
||||||
|
highlight(this, addItems);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var addItems = [];
|
||||||
|
var result = this.each(function() {
|
||||||
|
highlight(this, addItems);
|
||||||
|
});
|
||||||
|
for (var i = 0; i < addItems.length; ++i) {
|
||||||
|
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* backward compatibility for jQuery.browser
|
||||||
|
* This will be supported until firefox bug is fixed.
|
||||||
|
*/
|
||||||
|
if (!jQuery.browser) {
|
||||||
|
jQuery.uaMatch = function(ua) {
|
||||||
|
ua = ua.toLowerCase();
|
||||||
|
|
||||||
|
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||||
|
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||||
|
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||||
|
/(msie) ([\w.]+)/.exec(ua) ||
|
||||||
|
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||||
|
[];
|
||||||
|
|
||||||
|
return {
|
||||||
|
browser: match[ 1 ] || "",
|
||||||
|
version: match[ 2 ] || "0"
|
||||||
|
};
|
||||||
|
};
|
||||||
|
jQuery.browser = {};
|
||||||
|
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||||
|
}
|
152
docs/build/html/_static/basic.css
vendored
152
docs/build/html/_static/basic.css
vendored
@ -4,7 +4,7 @@
|
|||||||
*
|
*
|
||||||
* Sphinx stylesheet -- basic theme.
|
* Sphinx stylesheet -- basic theme.
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@ -130,7 +130,7 @@ ul.search li a {
|
|||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
ul.search li div.context {
|
ul.search li p.context {
|
||||||
color: #888;
|
color: #888;
|
||||||
margin: 2px 0 0 30px;
|
margin: 2px 0 0 30px;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
@ -222,7 +222,7 @@ table.modindextable td {
|
|||||||
/* -- general body styles --------------------------------------------------- */
|
/* -- general body styles --------------------------------------------------- */
|
||||||
|
|
||||||
div.body {
|
div.body {
|
||||||
min-width: 450px;
|
min-width: 360px;
|
||||||
max-width: 800px;
|
max-width: 800px;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -236,7 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote {
|
|||||||
a.headerlink {
|
a.headerlink {
|
||||||
visibility: hidden;
|
visibility: hidden;
|
||||||
}
|
}
|
||||||
|
|
||||||
a.brackets:before,
|
a.brackets:before,
|
||||||
span.brackets > a:before{
|
span.brackets > a:before{
|
||||||
content: "[";
|
content: "[";
|
||||||
@ -247,6 +246,7 @@ span.brackets > a:after {
|
|||||||
content: "]";
|
content: "]";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
h1:hover > a.headerlink,
|
h1:hover > a.headerlink,
|
||||||
h2:hover > a.headerlink,
|
h2:hover > a.headerlink,
|
||||||
h3:hover > a.headerlink,
|
h3:hover > a.headerlink,
|
||||||
@ -277,25 +277,25 @@ p.rubric {
|
|||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
img.align-left, .figure.align-left, object.align-left {
|
img.align-left, figure.align-left, .figure.align-left, object.align-left {
|
||||||
clear: left;
|
clear: left;
|
||||||
float: left;
|
float: left;
|
||||||
margin-right: 1em;
|
margin-right: 1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
img.align-right, .figure.align-right, object.align-right {
|
img.align-right, figure.align-right, .figure.align-right, object.align-right {
|
||||||
clear: right;
|
clear: right;
|
||||||
float: right;
|
float: right;
|
||||||
margin-left: 1em;
|
margin-left: 1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
img.align-center, .figure.align-center, object.align-center {
|
img.align-center, figure.align-center, .figure.align-center, object.align-center {
|
||||||
display: block;
|
display: block;
|
||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
margin-right: auto;
|
margin-right: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
img.align-default, .figure.align-default {
|
img.align-default, figure.align-default, .figure.align-default {
|
||||||
display: block;
|
display: block;
|
||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
margin-right: auto;
|
margin-right: auto;
|
||||||
@ -319,7 +319,8 @@ img.align-default, .figure.align-default {
|
|||||||
|
|
||||||
/* -- sidebars -------------------------------------------------------------- */
|
/* -- sidebars -------------------------------------------------------------- */
|
||||||
|
|
||||||
div.sidebar {
|
div.sidebar,
|
||||||
|
aside.sidebar {
|
||||||
margin: 0 0 0.5em 1em;
|
margin: 0 0 0.5em 1em;
|
||||||
border: 1px solid #ddb;
|
border: 1px solid #ddb;
|
||||||
padding: 7px;
|
padding: 7px;
|
||||||
@ -333,13 +334,11 @@ div.sidebar {
|
|||||||
p.sidebar-title {
|
p.sidebar-title {
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
div.admonition, div.topic, blockquote {
|
div.admonition, div.topic, blockquote {
|
||||||
clear: left;
|
clear: left;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* -- topics ---------------------------------------------------------------- */
|
/* -- topics ---------------------------------------------------------------- */
|
||||||
|
|
||||||
div.topic {
|
div.topic {
|
||||||
border: 1px solid #ccc;
|
border: 1px solid #ccc;
|
||||||
padding: 7px;
|
padding: 7px;
|
||||||
@ -377,12 +376,14 @@ div.body p.centered {
|
|||||||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||||
|
|
||||||
div.sidebar > :last-child,
|
div.sidebar > :last-child,
|
||||||
|
aside.sidebar > :last-child,
|
||||||
div.topic > :last-child,
|
div.topic > :last-child,
|
||||||
div.admonition > :last-child {
|
div.admonition > :last-child {
|
||||||
margin-bottom: 0;
|
margin-bottom: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
div.sidebar::after,
|
div.sidebar::after,
|
||||||
|
aside.sidebar::after,
|
||||||
div.topic::after,
|
div.topic::after,
|
||||||
div.admonition::after,
|
div.admonition::after,
|
||||||
blockquote::after {
|
blockquote::after {
|
||||||
@ -425,10 +426,6 @@ table.docutils td, table.docutils th {
|
|||||||
border-bottom: 1px solid #aaa;
|
border-bottom: 1px solid #aaa;
|
||||||
}
|
}
|
||||||
|
|
||||||
table.footnote td, table.footnote th {
|
|
||||||
border: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
th {
|
th {
|
||||||
text-align: left;
|
text-align: left;
|
||||||
padding-right: 5px;
|
padding-right: 5px;
|
||||||
@ -455,20 +452,22 @@ td > :last-child {
|
|||||||
|
|
||||||
/* -- figures --------------------------------------------------------------- */
|
/* -- figures --------------------------------------------------------------- */
|
||||||
|
|
||||||
div.figure {
|
div.figure, figure {
|
||||||
margin: 0.5em;
|
margin: 0.5em;
|
||||||
padding: 0.5em;
|
padding: 0.5em;
|
||||||
}
|
}
|
||||||
|
|
||||||
div.figure p.caption {
|
div.figure p.caption, figcaption {
|
||||||
padding: 0.3em;
|
padding: 0.3em;
|
||||||
}
|
}
|
||||||
|
|
||||||
div.figure p.caption span.caption-number {
|
div.figure p.caption span.caption-number,
|
||||||
|
figcaption span.caption-number {
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
}
|
}
|
||||||
|
|
||||||
div.figure p.caption span.caption-text {
|
div.figure p.caption span.caption-text,
|
||||||
|
figcaption span.caption-text {
|
||||||
}
|
}
|
||||||
|
|
||||||
/* -- field list styles ----------------------------------------------------- */
|
/* -- field list styles ----------------------------------------------------- */
|
||||||
@ -503,6 +502,63 @@ table.hlist td {
|
|||||||
vertical-align: top;
|
vertical-align: top;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* -- object description styles --------------------------------------------- */
|
||||||
|
|
||||||
|
.sig {
|
||||||
|
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig-name, code.descname {
|
||||||
|
background-color: transparent;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig-name {
|
||||||
|
font-size: 1.1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
code.descname {
|
||||||
|
font-size: 1.2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig-prename, code.descclassname {
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.optional {
|
||||||
|
font-size: 1.3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig-paren {
|
||||||
|
font-size: larger;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig-param.n {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* C++ specific styling */
|
||||||
|
|
||||||
|
.sig-inline.c-texpr,
|
||||||
|
.sig-inline.cpp-texpr {
|
||||||
|
font-family: unset;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig.c .k, .sig.c .kt,
|
||||||
|
.sig.cpp .k, .sig.cpp .kt {
|
||||||
|
color: #0033B3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig.c .m,
|
||||||
|
.sig.cpp .m {
|
||||||
|
color: #1750EB;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig.c .s, .sig.c .sc,
|
||||||
|
.sig.cpp .s, .sig.cpp .sc {
|
||||||
|
color: #067D17;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
/* -- other body styles ----------------------------------------------------- */
|
/* -- other body styles ----------------------------------------------------- */
|
||||||
|
|
||||||
@ -553,6 +609,7 @@ ul.simple p {
|
|||||||
margin-bottom: 0;
|
margin-bottom: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Docutils 0.17 and older (footnotes & citations) */
|
||||||
dl.footnote > dt,
|
dl.footnote > dt,
|
||||||
dl.citation > dt {
|
dl.citation > dt {
|
||||||
float: left;
|
float: left;
|
||||||
@ -570,6 +627,33 @@ dl.citation > dd:after {
|
|||||||
clear: both;
|
clear: both;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Docutils 0.18+ (footnotes & citations) */
|
||||||
|
aside.footnote > span,
|
||||||
|
div.citation > span {
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
aside.footnote > span:last-of-type,
|
||||||
|
div.citation > span:last-of-type {
|
||||||
|
padding-right: 0.5em;
|
||||||
|
}
|
||||||
|
aside.footnote > p {
|
||||||
|
margin-left: 2em;
|
||||||
|
}
|
||||||
|
div.citation > p {
|
||||||
|
margin-left: 4em;
|
||||||
|
}
|
||||||
|
aside.footnote > p:last-of-type,
|
||||||
|
div.citation > p:last-of-type {
|
||||||
|
margin-bottom: 0em;
|
||||||
|
}
|
||||||
|
aside.footnote > p:last-of-type:after,
|
||||||
|
div.citation > p:last-of-type:after {
|
||||||
|
content: "";
|
||||||
|
clear: both;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Footnotes & citations ends */
|
||||||
|
|
||||||
dl.field-list {
|
dl.field-list {
|
||||||
display: grid;
|
display: grid;
|
||||||
grid-template-columns: fit-content(30%) auto;
|
grid-template-columns: fit-content(30%) auto;
|
||||||
@ -629,14 +713,6 @@ dl.glossary dt {
|
|||||||
font-size: 1.1em;
|
font-size: 1.1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
.optional {
|
|
||||||
font-size: 1.3em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sig-paren {
|
|
||||||
font-size: larger;
|
|
||||||
}
|
|
||||||
|
|
||||||
.versionmodified {
|
.versionmodified {
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
}
|
}
|
||||||
@ -677,8 +753,9 @@ dl.glossary dt {
|
|||||||
|
|
||||||
.classifier:before {
|
.classifier:before {
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
margin: 0.5em;
|
margin: 0 0.5em;
|
||||||
content: ":";
|
content: ":";
|
||||||
|
display: inline-block;
|
||||||
}
|
}
|
||||||
|
|
||||||
abbr, acronym {
|
abbr, acronym {
|
||||||
@ -702,6 +779,7 @@ span.pre {
|
|||||||
-ms-hyphens: none;
|
-ms-hyphens: none;
|
||||||
-webkit-hyphens: none;
|
-webkit-hyphens: none;
|
||||||
hyphens: none;
|
hyphens: none;
|
||||||
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
div[class*="highlight-"] {
|
div[class*="highlight-"] {
|
||||||
@ -765,8 +843,12 @@ div.code-block-caption code {
|
|||||||
|
|
||||||
table.highlighttable td.linenos,
|
table.highlighttable td.linenos,
|
||||||
span.linenos,
|
span.linenos,
|
||||||
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
|
div.highlight span.gp { /* gp: Generic.Prompt */
|
||||||
user-select: none;
|
user-select: none;
|
||||||
|
-webkit-user-select: text; /* Safari fallback only */
|
||||||
|
-webkit-user-select: none; /* Chrome/Safari */
|
||||||
|
-moz-user-select: none; /* Firefox */
|
||||||
|
-ms-user-select: none; /* IE10+ */
|
||||||
}
|
}
|
||||||
|
|
||||||
div.code-block-caption span.caption-number {
|
div.code-block-caption span.caption-number {
|
||||||
@ -781,16 +863,6 @@ div.literal-block-wrapper {
|
|||||||
margin: 1em 0;
|
margin: 1em 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
code.descname {
|
|
||||||
background-color: transparent;
|
|
||||||
font-weight: bold;
|
|
||||||
font-size: 1.2em;
|
|
||||||
}
|
|
||||||
|
|
||||||
code.descclassname {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
code.xref, a code {
|
code.xref, a code {
|
||||||
background-color: transparent;
|
background-color: transparent;
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
|
4
docs/build/html/_static/css/theme.css
vendored
4
docs/build/html/_static/css/theme.css
vendored
File diff suppressed because one or more lines are too long
453
docs/build/html/_static/doctools.js
vendored
453
docs/build/html/_static/doctools.js
vendored
@ -2,320 +2,263 @@
|
|||||||
* doctools.js
|
* doctools.js
|
||||||
* ~~~~~~~~~~~
|
* ~~~~~~~~~~~
|
||||||
*
|
*
|
||||||
* Sphinx JavaScript utilities for all documentation.
|
* Base JavaScript utilities for all Sphinx HTML documentation.
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
"use strict";
|
||||||
|
|
||||||
/**
|
const _ready = (callback) => {
|
||||||
* select a different prefix for underscore
|
if (document.readyState !== "loading") {
|
||||||
*/
|
callback();
|
||||||
$u = _.noConflict();
|
} else {
|
||||||
|
document.addEventListener("DOMContentLoaded", callback);
|
||||||
/**
|
|
||||||
* make the code below compatible with browsers without
|
|
||||||
* an installed firebug like debugger
|
|
||||||
if (!window.console || !console.firebug) {
|
|
||||||
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
|
|
||||||
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
|
|
||||||
"profile", "profileEnd"];
|
|
||||||
window.console = {};
|
|
||||||
for (var i = 0; i < names.length; ++i)
|
|
||||||
window.console[names[i]] = function() {};
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* small helper function to urldecode strings
|
|
||||||
*
|
|
||||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
|
||||||
*/
|
|
||||||
jQuery.urldecode = function(x) {
|
|
||||||
if (!x) {
|
|
||||||
return x
|
|
||||||
}
|
}
|
||||||
return decodeURIComponent(x.replace(/\+/g, ' '));
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* small helper function to urlencode strings
|
* highlight a given string on a node by wrapping it in
|
||||||
*/
|
|
||||||
jQuery.urlencode = encodeURIComponent;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This function returns the parsed url parameters of the
|
|
||||||
* current request. Multiple values per key are supported,
|
|
||||||
* it will always return arrays of strings for the value parts.
|
|
||||||
*/
|
|
||||||
jQuery.getQueryParameters = function(s) {
|
|
||||||
if (typeof s === 'undefined')
|
|
||||||
s = document.location.search;
|
|
||||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
|
||||||
var result = {};
|
|
||||||
for (var i = 0; i < parts.length; i++) {
|
|
||||||
var tmp = parts[i].split('=', 2);
|
|
||||||
var key = jQuery.urldecode(tmp[0]);
|
|
||||||
var value = jQuery.urldecode(tmp[1]);
|
|
||||||
if (key in result)
|
|
||||||
result[key].push(value);
|
|
||||||
else
|
|
||||||
result[key] = [value];
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* highlight a given string on a jquery object by wrapping it in
|
|
||||||
* span elements with the given class name.
|
* span elements with the given class name.
|
||||||
*/
|
*/
|
||||||
jQuery.fn.highlightText = function(text, className) {
|
const _highlight = (node, addItems, text, className) => {
|
||||||
function highlight(node, addItems) {
|
if (node.nodeType === Node.TEXT_NODE) {
|
||||||
if (node.nodeType === 3) {
|
const val = node.nodeValue;
|
||||||
var val = node.nodeValue;
|
const parent = node.parentNode;
|
||||||
var pos = val.toLowerCase().indexOf(text);
|
const pos = val.toLowerCase().indexOf(text);
|
||||||
if (pos >= 0 &&
|
if (
|
||||||
!jQuery(node.parentNode).hasClass(className) &&
|
pos >= 0 &&
|
||||||
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
!parent.classList.contains(className) &&
|
||||||
var span;
|
!parent.classList.contains("nohighlight")
|
||||||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
) {
|
||||||
if (isInSVG) {
|
let span;
|
||||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
|
||||||
} else {
|
const closestNode = parent.closest("body, svg, foreignObject");
|
||||||
span = document.createElement("span");
|
const isInSVG = closestNode && closestNode.matches("svg");
|
||||||
span.className = className;
|
if (isInSVG) {
|
||||||
}
|
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
} else {
|
||||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
span = document.createElement("span");
|
||||||
|
span.classList.add(className);
|
||||||
|
}
|
||||||
|
|
||||||
|
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||||
|
parent.insertBefore(
|
||||||
|
span,
|
||||||
|
parent.insertBefore(
|
||||||
document.createTextNode(val.substr(pos + text.length)),
|
document.createTextNode(val.substr(pos + text.length)),
|
||||||
node.nextSibling));
|
node.nextSibling
|
||||||
node.nodeValue = val.substr(0, pos);
|
)
|
||||||
if (isInSVG) {
|
);
|
||||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
node.nodeValue = val.substr(0, pos);
|
||||||
var bbox = node.parentElement.getBBox();
|
|
||||||
rect.x.baseVal.value = bbox.x;
|
if (isInSVG) {
|
||||||
rect.y.baseVal.value = bbox.y;
|
const rect = document.createElementNS(
|
||||||
rect.width.baseVal.value = bbox.width;
|
"http://www.w3.org/2000/svg",
|
||||||
rect.height.baseVal.value = bbox.height;
|
"rect"
|
||||||
rect.setAttribute('class', className);
|
);
|
||||||
addItems.push({
|
const bbox = parent.getBBox();
|
||||||
"parent": node.parentNode,
|
rect.x.baseVal.value = bbox.x;
|
||||||
"target": rect});
|
rect.y.baseVal.value = bbox.y;
|
||||||
}
|
rect.width.baseVal.value = bbox.width;
|
||||||
|
rect.height.baseVal.value = bbox.height;
|
||||||
|
rect.setAttribute("class", className);
|
||||||
|
addItems.push({ parent: parent, target: rect });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
else if (!jQuery(node).is("button, select, textarea")) {
|
} else if (node.matches && !node.matches("button, select, textarea")) {
|
||||||
jQuery.each(node.childNodes, function() {
|
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
|
||||||
highlight(this, addItems);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
var addItems = [];
|
|
||||||
var result = this.each(function() {
|
|
||||||
highlight(this, addItems);
|
|
||||||
});
|
|
||||||
for (var i = 0; i < addItems.length; ++i) {
|
|
||||||
jQuery(addItems[i].parent).before(addItems[i].target);
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
};
|
};
|
||||||
|
const _highlightText = (thisNode, text, className) => {
|
||||||
/*
|
let addItems = [];
|
||||||
* backward compatibility for jQuery.browser
|
_highlight(thisNode, addItems, text, className);
|
||||||
* This will be supported until firefox bug is fixed.
|
addItems.forEach((obj) =>
|
||||||
*/
|
obj.parent.insertAdjacentElement("beforebegin", obj.target)
|
||||||
if (!jQuery.browser) {
|
);
|
||||||
jQuery.uaMatch = function(ua) {
|
};
|
||||||
ua = ua.toLowerCase();
|
|
||||||
|
|
||||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
|
||||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
|
||||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
|
||||||
/(msie) ([\w.]+)/.exec(ua) ||
|
|
||||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
|
||||||
[];
|
|
||||||
|
|
||||||
return {
|
|
||||||
browser: match[ 1 ] || "",
|
|
||||||
version: match[ 2 ] || "0"
|
|
||||||
};
|
|
||||||
};
|
|
||||||
jQuery.browser = {};
|
|
||||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Small JavaScript module for the documentation.
|
* Small JavaScript module for the documentation.
|
||||||
*/
|
*/
|
||||||
var Documentation = {
|
const Documentation = {
|
||||||
|
init: () => {
|
||||||
init : function() {
|
Documentation.highlightSearchWords();
|
||||||
this.fixFirefoxAnchorBug();
|
Documentation.initDomainIndexTable();
|
||||||
this.highlightSearchWords();
|
Documentation.initOnKeyListeners();
|
||||||
this.initIndexTable();
|
|
||||||
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
|
|
||||||
this.initOnKeyListeners();
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* i18n support
|
* i18n support
|
||||||
*/
|
*/
|
||||||
TRANSLATIONS : {},
|
TRANSLATIONS: {},
|
||||||
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
|
PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
|
||||||
LOCALE : 'unknown',
|
LOCALE: "unknown",
|
||||||
|
|
||||||
// gettext and ngettext don't access this so that the functions
|
// gettext and ngettext don't access this so that the functions
|
||||||
// can safely bound to a different name (_ = Documentation.gettext)
|
// can safely bound to a different name (_ = Documentation.gettext)
|
||||||
gettext : function(string) {
|
gettext: (string) => {
|
||||||
var translated = Documentation.TRANSLATIONS[string];
|
const translated = Documentation.TRANSLATIONS[string];
|
||||||
if (typeof translated === 'undefined')
|
switch (typeof translated) {
|
||||||
return string;
|
case "undefined":
|
||||||
return (typeof translated === 'string') ? translated : translated[0];
|
return string; // no translation
|
||||||
|
case "string":
|
||||||
|
return translated; // translation exists
|
||||||
|
default:
|
||||||
|
return translated[0]; // (singular, plural) translation tuple exists
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
ngettext : function(singular, plural, n) {
|
ngettext: (singular, plural, n) => {
|
||||||
var translated = Documentation.TRANSLATIONS[singular];
|
const translated = Documentation.TRANSLATIONS[singular];
|
||||||
if (typeof translated === 'undefined')
|
if (typeof translated !== "undefined")
|
||||||
return (n == 1) ? singular : plural;
|
return translated[Documentation.PLURAL_EXPR(n)];
|
||||||
return translated[Documentation.PLURALEXPR(n)];
|
return n === 1 ? singular : plural;
|
||||||
},
|
},
|
||||||
|
|
||||||
addTranslations : function(catalog) {
|
addTranslations: (catalog) => {
|
||||||
for (var key in catalog.messages)
|
Object.assign(Documentation.TRANSLATIONS, catalog.messages);
|
||||||
this.TRANSLATIONS[key] = catalog.messages[key];
|
Documentation.PLURAL_EXPR = new Function(
|
||||||
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
|
"n",
|
||||||
this.LOCALE = catalog.locale;
|
`return (${catalog.plural_expr})`
|
||||||
},
|
);
|
||||||
|
Documentation.LOCALE = catalog.locale;
|
||||||
/**
|
|
||||||
* add context elements like header anchor links
|
|
||||||
*/
|
|
||||||
addContextElements : function() {
|
|
||||||
$('div[id] > :header:first').each(function() {
|
|
||||||
$('<a class="headerlink">\u00B6</a>').
|
|
||||||
attr('href', '#' + this.id).
|
|
||||||
attr('title', _('Permalink to this headline')).
|
|
||||||
appendTo(this);
|
|
||||||
});
|
|
||||||
$('dt[id]').each(function() {
|
|
||||||
$('<a class="headerlink">\u00B6</a>').
|
|
||||||
attr('href', '#' + this.id).
|
|
||||||
attr('title', _('Permalink to this definition')).
|
|
||||||
appendTo(this);
|
|
||||||
});
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* workaround a firefox stupidity
|
|
||||||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
|
||||||
*/
|
|
||||||
fixFirefoxAnchorBug : function() {
|
|
||||||
if (document.location.hash && $.browser.mozilla)
|
|
||||||
window.setTimeout(function() {
|
|
||||||
document.location.href += '';
|
|
||||||
}, 10);
|
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* highlight the search words provided in the url in the text
|
* highlight the search words provided in the url in the text
|
||||||
*/
|
*/
|
||||||
highlightSearchWords : function() {
|
highlightSearchWords: () => {
|
||||||
var params = $.getQueryParameters();
|
const highlight =
|
||||||
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
|
new URLSearchParams(window.location.search).get("highlight") || "";
|
||||||
if (terms.length) {
|
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
|
||||||
var body = $('div.body');
|
if (terms.length === 0) return; // nothing to do
|
||||||
if (!body.length) {
|
|
||||||
body = $('body');
|
|
||||||
}
|
|
||||||
window.setTimeout(function() {
|
|
||||||
$.each(terms, function() {
|
|
||||||
body.highlightText(this.toLowerCase(), 'highlighted');
|
|
||||||
});
|
|
||||||
}, 10);
|
|
||||||
$('<p class="highlight-link"><a href="javascript:Documentation.' +
|
|
||||||
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
|
|
||||||
.appendTo($('#searchbox'));
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
// There should never be more than one element matching "div.body"
|
||||||
* init the domain index toggle buttons
|
const divBody = document.querySelectorAll("div.body");
|
||||||
*/
|
const body = divBody.length ? divBody[0] : document.querySelector("body");
|
||||||
initIndexTable : function() {
|
window.setTimeout(() => {
|
||||||
var togglers = $('img.toggler').click(function() {
|
terms.forEach((term) => _highlightText(body, term, "highlighted"));
|
||||||
var src = $(this).attr('src');
|
}, 10);
|
||||||
var idnum = $(this).attr('id').substr(7);
|
|
||||||
$('tr.cg-' + idnum).toggle();
|
const searchBox = document.getElementById("searchbox");
|
||||||
if (src.substr(-9) === 'minus.png')
|
if (searchBox === null) return;
|
||||||
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
searchBox.appendChild(
|
||||||
else
|
document
|
||||||
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
.createRange()
|
||||||
}).css('display', '');
|
.createContextualFragment(
|
||||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
|
'<p class="highlight-link">' +
|
||||||
togglers.click();
|
'<a href="javascript:Documentation.hideSearchWords()">' +
|
||||||
}
|
Documentation.gettext("Hide Search Matches") +
|
||||||
|
"</a></p>"
|
||||||
|
)
|
||||||
|
);
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* helper function to hide the search marks again
|
* helper function to hide the search marks again
|
||||||
*/
|
*/
|
||||||
hideSearchWords : function() {
|
hideSearchWords: () => {
|
||||||
$('#searchbox .highlight-link').fadeOut(300);
|
document
|
||||||
$('span.highlighted').removeClass('highlighted');
|
.querySelectorAll("#searchbox .highlight-link")
|
||||||
|
.forEach((el) => el.remove());
|
||||||
|
document
|
||||||
|
.querySelectorAll("span.highlighted")
|
||||||
|
.forEach((el) => el.classList.remove("highlighted"));
|
||||||
|
const url = new URL(window.location);
|
||||||
|
url.searchParams.delete("highlight");
|
||||||
|
window.history.replaceState({}, "", url);
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* make the url absolute
|
* helper function to focus on search bar
|
||||||
*/
|
*/
|
||||||
makeURL : function(relativeURL) {
|
focusSearchBar: () => {
|
||||||
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
|
document.querySelectorAll("input[name=q]")[0]?.focus();
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* get the current relative url
|
* Initialise the domain index toggle buttons
|
||||||
*/
|
*/
|
||||||
getCurrentURL : function() {
|
initDomainIndexTable: () => {
|
||||||
var path = document.location.pathname;
|
const toggler = (el) => {
|
||||||
var parts = path.split(/\//);
|
const idNumber = el.id.substr(7);
|
||||||
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
|
||||||
if (this === '..')
|
if (el.src.substr(-9) === "minus.png") {
|
||||||
parts.pop();
|
el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
|
||||||
});
|
toggledRows.forEach((el) => (el.style.display = "none"));
|
||||||
var url = parts.join('/');
|
} else {
|
||||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
|
||||||
|
toggledRows.forEach((el) => (el.style.display = ""));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const togglerElements = document.querySelectorAll("img.toggler");
|
||||||
|
togglerElements.forEach((el) =>
|
||||||
|
el.addEventListener("click", (event) => toggler(event.currentTarget))
|
||||||
|
);
|
||||||
|
togglerElements.forEach((el) => (el.style.display = ""));
|
||||||
|
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
|
||||||
},
|
},
|
||||||
|
|
||||||
initOnKeyListeners: function() {
|
initOnKeyListeners: () => {
|
||||||
$(document).keydown(function(event) {
|
// only install a listener if it is really needed
|
||||||
var activeElementType = document.activeElement.tagName;
|
if (
|
||||||
// don't navigate when in search box, textarea, dropdown or button
|
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
|
||||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
|
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
|
||||||
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
|
)
|
||||||
&& !event.shiftKey) {
|
return;
|
||||||
switch (event.keyCode) {
|
|
||||||
case 37: // left
|
const blacklistedElements = new Set([
|
||||||
var prevHref = $('link[rel="prev"]').prop('href');
|
"TEXTAREA",
|
||||||
if (prevHref) {
|
"INPUT",
|
||||||
window.location.href = prevHref;
|
"SELECT",
|
||||||
return false;
|
"BUTTON",
|
||||||
|
]);
|
||||||
|
document.addEventListener("keydown", (event) => {
|
||||||
|
if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements
|
||||||
|
if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys
|
||||||
|
|
||||||
|
if (!event.shiftKey) {
|
||||||
|
switch (event.key) {
|
||||||
|
case "ArrowLeft":
|
||||||
|
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
|
||||||
|
|
||||||
|
const prevLink = document.querySelector('link[rel="prev"]');
|
||||||
|
if (prevLink && prevLink.href) {
|
||||||
|
window.location.href = prevLink.href;
|
||||||
|
event.preventDefault();
|
||||||
}
|
}
|
||||||
case 39: // right
|
break;
|
||||||
var nextHref = $('link[rel="next"]').prop('href');
|
case "ArrowRight":
|
||||||
if (nextHref) {
|
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
|
||||||
window.location.href = nextHref;
|
|
||||||
return false;
|
const nextLink = document.querySelector('link[rel="next"]');
|
||||||
|
if (nextLink && nextLink.href) {
|
||||||
|
window.location.href = nextLink.href;
|
||||||
|
event.preventDefault();
|
||||||
}
|
}
|
||||||
|
break;
|
||||||
|
case "Escape":
|
||||||
|
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
|
||||||
|
Documentation.hideSearchWords();
|
||||||
|
event.preventDefault();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// some keyboard layouts may need Shift to get /
|
||||||
|
switch (event.key) {
|
||||||
|
case "/":
|
||||||
|
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
|
||||||
|
Documentation.focusSearchBar();
|
||||||
|
event.preventDefault();
|
||||||
|
}
|
||||||
});
|
});
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
// quick alias for translations
|
// quick alias for translations
|
||||||
_ = Documentation.gettext;
|
const _ = Documentation.gettext;
|
||||||
|
|
||||||
$(document).ready(function() {
|
_ready(Documentation.init);
|
||||||
Documentation.init();
|
|
||||||
});
|
|
||||||
|
@ -1,12 +1,14 @@
|
|||||||
var DOCUMENTATION_OPTIONS = {
|
var DOCUMENTATION_OPTIONS = {
|
||||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||||
VERSION: '',
|
VERSION: '',
|
||||||
LANGUAGE: 'None',
|
LANGUAGE: 'en',
|
||||||
COLLAPSE_INDEX: false,
|
COLLAPSE_INDEX: false,
|
||||||
BUILDER: 'html',
|
BUILDER: 'html',
|
||||||
FILE_SUFFIX: '.html',
|
FILE_SUFFIX: '.html',
|
||||||
LINK_SUFFIX: '.html',
|
LINK_SUFFIX: '.html',
|
||||||
HAS_SOURCE: true,
|
HAS_SOURCE: true,
|
||||||
SOURCELINK_SUFFIX: '.txt',
|
SOURCELINK_SUFFIX: '.txt',
|
||||||
NAVIGATION_WITH_KEYS: false
|
NAVIGATION_WITH_KEYS: false,
|
||||||
|
SHOW_SEARCH_SUMMARY: true,
|
||||||
|
ENABLE_SEARCH_SHORTCUTS: false,
|
||||||
};
|
};
|
BIN
docs/build/html/_static/fonts/Inconsolata-Bold.ttf
vendored
BIN
docs/build/html/_static/fonts/Inconsolata-Bold.ttf
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/html/_static/fonts/Inconsolata.ttf
vendored
BIN
docs/build/html/_static/fonts/Inconsolata.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato-Bold.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato-Bold.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato-Regular.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato-Regular.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-bold.eot
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-bold.eot
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-bold.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-bold.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-bold.woff
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-bold.woff
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-bold.woff2
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-bold.woff2
vendored
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-italic.eot
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-italic.eot
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-italic.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-italic.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-italic.woff
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-italic.woff
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-italic.woff2
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-italic.woff2
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-regular.eot
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-regular.eot
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-regular.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-regular.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-regular.woff
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-regular.woff
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/html/_static/fonts/RobotoSlab-Bold.ttf
vendored
BIN
docs/build/html/_static/fonts/RobotoSlab-Bold.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/RobotoSlab-Regular.ttf
vendored
BIN
docs/build/html/_static/fonts/RobotoSlab-Regular.ttf
vendored
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user