simstack 2.0.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- simstack/__init__.py +0 -0
- simstack/_version.py +24 -0
- simstack/core/__init__.py +0 -0
- simstack/core/artifacts.py +406 -0
- simstack/core/asnyc_helper.py +14 -0
- simstack/core/config_file.py +60 -0
- simstack/core/context.py +283 -0
- simstack/core/definitions.py +22 -0
- simstack/core/engine.py +115 -0
- simstack/core/find_simstack_modules.py +41 -0
- simstack/core/hash.py +179 -0
- simstack/core/node.py +1137 -0
- simstack/core/node_claim.py +31 -0
- simstack/core/node_runner.py +362 -0
- simstack/core/process_results.py +102 -0
- simstack/core/recompute_artifacts.py +117 -0
- simstack/core/reset_db.py +12 -0
- simstack/core/resource_assignment.py +222 -0
- simstack/core/resources.py +90 -0
- simstack/core/route_table.py +24 -0
- simstack/core/run_docker.py +109 -0
- simstack/core/run_node.py +71 -0
- simstack/core/runner.py +169 -0
- simstack/core/services/__init__.py +11 -0
- simstack/core/services/base_service.py +191 -0
- simstack/core/services/file_transfer_service.py +117 -0
- simstack/core/services/git_restart_service.py +12 -0
- simstack/core/services/git_uv_update_service.py +105 -0
- simstack/core/services/node_execution_service.py +182 -0
- simstack/core/services/resource_branch_monitor_service.py +71 -0
- simstack/core/services/runner_cleanup_service.py +149 -0
- simstack/core/services/runner_manager.py +163 -0
- simstack/core/services/runner_status_service.py +10 -0
- simstack/core/services/slurm_status_service.py +67 -0
- simstack/core/services/stop_check_service.py +27 -0
- simstack/core/services/timeout_restart_service.py +26 -0
- simstack/core/simstack_result.py +39 -0
- simstack/core/submit_node.py +217 -0
- simstack/core/task_id.py +22 -0
- simstack/methods/__init__.py +0 -0
- simstack/methods/archive_files.py +292 -0
- simstack/methods/fire_and_forget_runner.py +113 -0
- simstack/methods/generate_test.py +125 -0
- simstack/methods/get_file.py +26 -0
- simstack/methods/mass_runner.py +154 -0
- simstack/methods/multiple_executor.py +307 -0
- simstack/methods/switch_git.py +16 -0
- simstack/methods/upload_helpers.py +81 -0
- simstack/models/__init__.py +74 -0
- simstack/models/array_list.py +21 -0
- simstack/models/array_storage.py +83 -0
- simstack/models/artifact_models.py +127 -0
- simstack/models/base_lists.py +51 -0
- simstack/models/base_types.py +209 -0
- simstack/models/charts_artifact.py +690 -0
- simstack/models/dataset.py +451 -0
- simstack/models/dataset_metadata.py +390 -0
- simstack/models/datasettuple.py +587 -0
- simstack/models/file_instance.py +150 -0
- simstack/models/file_list.py +45 -0
- simstack/models/files.py +424 -0
- simstack/models/fire_and_forget_result.py +19 -0
- simstack/models/images2d.py +113 -0
- simstack/models/log_entry_model.py +37 -0
- simstack/models/models.py +52 -0
- simstack/models/named_data_reference.py +36 -0
- simstack/models/node_registry.py +96 -0
- simstack/models/pandas_model.py +239 -0
- simstack/models/parameters.py +402 -0
- simstack/models/pickle_models.py +300 -0
- simstack/models/project.py +13 -0
- simstack/models/resource_assignment.py +170 -0
- simstack/models/resource_definition.py +125 -0
- simstack/models/runner_model.py +39 -0
- simstack/models/simple_table.py +79 -0
- simstack/models/simstack_model.py +97 -0
- simstack/models/slurm_info.py +17 -0
- simstack/models/table_artifact.py +87 -0
- simstack/models/tag.py +12 -0
- simstack/models/unused_test_file.py +5 -0
- simstack/simstack_marker.com +1 -0
- simstack/static/docs/.buildinfo +4 -0
- simstack/static/docs/_images/GUI Concept.webp +0 -0
- simstack/static/docs/_modules/index.html +434 -0
- simstack/static/docs/_modules/simstack/core/artifacts.html +743 -0
- simstack/static/docs/_modules/simstack/core/asnyc_helper.html +330 -0
- simstack/static/docs/_modules/simstack/core/config_file.html +379 -0
- simstack/static/docs/_modules/simstack/core/definitions.html +341 -0
- simstack/static/docs/_modules/simstack/core/engine.html +437 -0
- simstack/static/docs/_modules/simstack/core/find_simstack_modules.html +360 -0
- simstack/static/docs/_modules/simstack/core/hash.html +528 -0
- simstack/static/docs/_modules/simstack/core/node.html +1392 -0
- simstack/static/docs/_modules/simstack/core/node_claim.html +347 -0
- simstack/static/docs/_modules/simstack/core/node_runner.html +711 -0
- simstack/static/docs/_modules/simstack/core/process_results.html +418 -0
- simstack/static/docs/_modules/simstack/core/recompute_artifacts.html +433 -0
- simstack/static/docs/_modules/simstack/core/reset_db.html +328 -0
- simstack/static/docs/_modules/simstack/core/resource_assignment.html +553 -0
- simstack/static/docs/_modules/simstack/core/resources.html +424 -0
- simstack/static/docs/_modules/simstack/core/route_table.html +349 -0
- simstack/static/docs/_modules/simstack/core/run_docker.html +425 -0
- simstack/static/docs/_modules/simstack/core/run_node.html +390 -0
- simstack/static/docs/_modules/simstack/core/runner.html +491 -0
- simstack/static/docs/_modules/simstack/core/services/base_service.html +522 -0
- simstack/static/docs/_modules/simstack/core/services/file_transfer_service.html +436 -0
- simstack/static/docs/_modules/simstack/core/services/git_restart_service.html +331 -0
- simstack/static/docs/_modules/simstack/core/services/git_uv_update_service.html +427 -0
- simstack/static/docs/_modules/simstack/core/services/node_execution_service.html +507 -0
- simstack/static/docs/_modules/simstack/core/services/resource_branch_monitor_service.html +390 -0
- simstack/static/docs/_modules/simstack/core/services/runner_cleanup_service.html +468 -0
- simstack/static/docs/_modules/simstack/core/services/runner_manager.html +485 -0
- simstack/static/docs/_modules/simstack/core/services/runner_status_service.html +329 -0
- simstack/static/docs/_modules/simstack/core/services/slurm_status_service.html +386 -0
- simstack/static/docs/_modules/simstack/core/services/stop_check_service.html +346 -0
- simstack/static/docs/_modules/simstack/core/services/timeout_restart_service.html +345 -0
- simstack/static/docs/_modules/simstack/core/simstack_result.html +355 -0
- simstack/static/docs/_modules/simstack/core/submit_node.html +536 -0
- simstack/static/docs/_modules/simstack/core/task_id.html +344 -0
- simstack/static/docs/_modules/simstack/methods/archive_files.html +598 -0
- simstack/static/docs/_modules/simstack/methods/fire_and_forget_runner.html +432 -0
- simstack/static/docs/_modules/simstack/methods/generate_test.html +443 -0
- simstack/static/docs/_modules/simstack/methods/get_file.html +342 -0
- simstack/static/docs/_modules/simstack/methods/mass_runner.html +476 -0
- simstack/static/docs/_modules/simstack/methods/multiple_executor.html +674 -0
- simstack/static/docs/_modules/simstack/methods/switch_git.html +332 -0
- simstack/static/docs/_modules/simstack/methods/upload_helpers.html +403 -0
- simstack/static/docs/_modules/simstack/models/array_list.html +337 -0
- simstack/static/docs/_modules/simstack/models/array_storage.html +417 -0
- simstack/static/docs/_modules/simstack/models/base_lists.html +374 -0
- simstack/static/docs/_modules/simstack/models/base_types.html +588 -0
- simstack/static/docs/_modules/simstack/models/charts_artifact.html +1035 -0
- simstack/static/docs/_modules/simstack/models/dataset.html +866 -0
- simstack/static/docs/_modules/simstack/models/dataset_metadata.html +711 -0
- simstack/static/docs/_modules/simstack/models/datasettuple.html +1005 -0
- simstack/static/docs/_modules/simstack/models/file_instance.html +472 -0
- simstack/static/docs/_modules/simstack/models/file_list.html +367 -0
- simstack/static/docs/_modules/simstack/models/files.html +773 -0
- simstack/static/docs/_modules/simstack/models/fire_and_forget_result.html +335 -0
- simstack/static/docs/_modules/simstack/models/images2d.html +447 -0
- simstack/static/docs/_modules/simstack/models/log_entry_model.html +356 -0
- simstack/static/docs/_modules/simstack/models/models.html +374 -0
- simstack/static/docs/_modules/simstack/models/named_data_reference.html +355 -0
- simstack/static/docs/_modules/simstack/models/node_registry.html +415 -0
- simstack/static/docs/_modules/simstack/models/pandas_model.html +570 -0
- simstack/static/docs/_modules/simstack/models/parameters.html +739 -0
- simstack/static/docs/_modules/simstack/models/pickle_models.html +631 -0
- simstack/static/docs/_modules/simstack/models/project.html +329 -0
- simstack/static/docs/_modules/simstack/models/resource_assignment.html +501 -0
- simstack/static/docs/_modules/simstack/models/resource_definition.html +477 -0
- simstack/static/docs/_modules/simstack/models/runner_model.html +361 -0
- simstack/static/docs/_modules/simstack/models/simple_table.html +413 -0
- simstack/static/docs/_modules/simstack/models/simstack_model.html +416 -0
- simstack/static/docs/_modules/simstack/models/slurm_info.html +333 -0
- simstack/static/docs/_modules/simstack/models/table_artifact.html +406 -0
- simstack/static/docs/_modules/simstack/models/tag.html +328 -0
- simstack/static/docs/_modules/simstack/tables/model_table.html +519 -0
- simstack/static/docs/_modules/simstack/tables/node_children.html +538 -0
- simstack/static/docs/_modules/simstack/tables/node_table.html +854 -0
- simstack/static/docs/_modules/simstack/tables/table_builder.html +642 -0
- simstack/static/docs/_modules/simstack/util/async_zip_utils.html +337 -0
- simstack/static/docs/_modules/simstack/util/b64mixin.html +339 -0
- simstack/static/docs/_modules/simstack/util/cleaned_json_schema.html +336 -0
- simstack/static/docs/_modules/simstack/util/config_reader.html +498 -0
- simstack/static/docs/_modules/simstack/util/custom_model_dump.html +391 -0
- simstack/static/docs/_modules/simstack/util/database_information.html +488 -0
- simstack/static/docs/_modules/simstack/util/db.html +1392 -0
- simstack/static/docs/_modules/simstack/util/db_logger.html +448 -0
- simstack/static/docs/_modules/simstack/util/default_from_dict.html +376 -0
- simstack/static/docs/_modules/simstack/util/directory_iterator.html +553 -0
- simstack/static/docs/_modules/simstack/util/docstring_parser.html +526 -0
- simstack/static/docs/_modules/simstack/util/file_hashing.html +394 -0
- simstack/static/docs/_modules/simstack/util/file_transfer_client.html +791 -0
- simstack/static/docs/_modules/simstack/util/files.html +733 -0
- simstack/static/docs/_modules/simstack/util/find_python_files.html +349 -0
- simstack/static/docs/_modules/simstack/util/generate_ui_schema.html +396 -0
- simstack/static/docs/_modules/simstack/util/generic_list_mixin.html +487 -0
- simstack/static/docs/_modules/simstack/util/get_module_path.html +336 -0
- simstack/static/docs/_modules/simstack/util/git_pull.html +381 -0
- simstack/static/docs/_modules/simstack/util/git_repository_status.html +411 -0
- simstack/static/docs/_modules/simstack/util/import_module.html +377 -0
- simstack/static/docs/_modules/simstack/util/importer.html +637 -0
- simstack/static/docs/_modules/simstack/util/init_data_source.html +357 -0
- simstack/static/docs/_modules/simstack/util/make_graph.html +423 -0
- simstack/static/docs/_modules/simstack/util/make_table.html +1171 -0
- simstack/static/docs/_modules/simstack/util/mappings.html +378 -0
- simstack/static/docs/_modules/simstack/util/minimal_route_finder.html +388 -0
- simstack/static/docs/_modules/simstack/util/mock_db.html +472 -0
- simstack/static/docs/_modules/simstack/util/module_path_checker.html +354 -0
- simstack/static/docs/_modules/simstack/util/object_list_mixin.html +649 -0
- simstack/static/docs/_modules/simstack/util/path_manager.html +566 -0
- simstack/static/docs/_modules/simstack/util/project_root_finder.html +357 -0
- simstack/static/docs/_modules/simstack/util/queue_watcher.html +593 -0
- simstack/static/docs/_modules/simstack/util/resource_config.html +532 -0
- simstack/static/docs/_modules/simstack/util/route_finder.html +390 -0
- simstack/static/docs/_modules/simstack/util/runner_util.html +487 -0
- simstack/static/docs/_modules/simstack/util/runner_utils.html +468 -0
- simstack/static/docs/_modules/simstack/util/safe_code_executor.html +510 -0
- simstack/static/docs/_modules/simstack/util/sample_config.html +414 -0
- simstack/static/docs/_modules/simstack/util/sensitive_content_filter.html +364 -0
- simstack/static/docs/_modules/simstack/util/setup_logging.html +365 -0
- simstack/static/docs/_modules/simstack/util/submit_to_watchdog.html +425 -0
- simstack/static/docs/_modules/simstack/util/toml_reader.html +482 -0
- simstack/static/docs/_modules/simstack/util/transform_file_name.html +357 -0
- simstack/static/docs/_modules/simstack/util/ui_tools.html +541 -0
- simstack/static/docs/_sources/architecture.rst.txt +25 -0
- simstack/static/docs/_sources/array_lists.rst.txt +60 -0
- simstack/static/docs/_sources/ci_pipeline.rst.txt +34 -0
- simstack/static/docs/_sources/data.rst.txt +175 -0
- simstack/static/docs/_sources/database_migrations.rst.txt +310 -0
- simstack/static/docs/_sources/datasets.rst.txt +93 -0
- simstack/static/docs/_sources/developer_guide.rst.txt +25 -0
- simstack/static/docs/_sources/docker_nodes.rst.txt +149 -0
- simstack/static/docs/_sources/files.rst.txt +159 -0
- simstack/static/docs/_sources/fire_and_forget_runner.rst.txt +67 -0
- simstack/static/docs/_sources/index.rst.txt +25 -0
- simstack/static/docs/_sources/installation.rst.txt +213 -0
- simstack/static/docs/_sources/lists.rst.txt +111 -0
- simstack/static/docs/_sources/mass_runner.rst.txt +91 -0
- simstack/static/docs/_sources/misc.rst.txt +106 -0
- simstack/static/docs/_sources/overview.rst.txt +91 -0
- simstack/static/docs/_sources/recovery.rst.txt +38 -0
- simstack/static/docs/_sources/resource_config.rst.txt +141 -0
- simstack/static/docs/_sources/simstack/modules/modules.rst.txt +7 -0
- simstack/static/docs/_sources/simstack/modules/simstack.core.rst.txt +205 -0
- simstack/static/docs/_sources/simstack/modules/simstack.core.services.rst.txt +109 -0
- simstack/static/docs/_sources/simstack/modules/simstack.methods.rst.txt +77 -0
- simstack/static/docs/_sources/simstack/modules/simstack.models.rst.txt +261 -0
- simstack/static/docs/_sources/simstack/modules/simstack.rst.txt +22 -0
- simstack/static/docs/_sources/simstack/modules/simstack.tables.rst.txt +45 -0
- simstack/static/docs/_sources/simstack/modules/simstack.util.rst.txt +381 -0
- simstack/static/docs/_sources/submit.rst.txt +141 -0
- simstack/static/docs/_sources/tables.rst.txt +50 -0
- simstack/static/docs/_sources/testing_complex_nodes.rst.txt +92 -0
- simstack/static/docs/_sources/ui_documentation.rst.txt +272 -0
- simstack/static/docs/_sources/workflows.rst.txt +446 -0
- simstack/static/docs/_static/base-stemmer.js +476 -0
- simstack/static/docs/_static/basic.css +906 -0
- simstack/static/docs/_static/cobalt2-theme.css +1 -0
- simstack/static/docs/_static/debug.css +69 -0
- simstack/static/docs/_static/docs-build-badge.css +51 -0
- simstack/static/docs/_static/docs-build-badge.js +51 -0
- simstack/static/docs/_static/doctools.js +150 -0
- simstack/static/docs/_static/documentation_options.js +13 -0
- simstack/static/docs/_static/english-stemmer.js +1066 -0
- simstack/static/docs/_static/file.png +0 -0
- simstack/static/docs/_static/language_data.js +13 -0
- simstack/static/docs/_static/minus.png +0 -0
- simstack/static/docs/_static/plus.png +0 -0
- simstack/static/docs/_static/pygments.css +250 -0
- simstack/static/docs/_static/scripts/furo-extensions.js +0 -0
- simstack/static/docs/_static/scripts/furo.js +3 -0
- simstack/static/docs/_static/scripts/furo.js.LICENSE.txt +7 -0
- simstack/static/docs/_static/scripts/furo.js.map +1 -0
- simstack/static/docs/_static/searchtools.js +693 -0
- simstack/static/docs/_static/skeleton.css +296 -0
- simstack/static/docs/_static/sphinx_highlight.js +159 -0
- simstack/static/docs/_static/styles/furo-extensions.css +2 -0
- simstack/static/docs/_static/styles/furo-extensions.css.map +1 -0
- simstack/static/docs/_static/styles/furo.css +2 -0
- simstack/static/docs/_static/styles/furo.css.map +1 -0
- simstack/static/docs/architecture.html +340 -0
- simstack/static/docs/array_lists.html +678 -0
- simstack/static/docs/ci_pipeline.html +385 -0
- simstack/static/docs/data.html +545 -0
- simstack/static/docs/database_migrations.html +652 -0
- simstack/static/docs/datasets.html +1268 -0
- simstack/static/docs/developer_guide.html +359 -0
- simstack/static/docs/docker_nodes.html +503 -0
- simstack/static/docs/files.html +718 -0
- simstack/static/docs/fire_and_forget_runner.html +641 -0
- simstack/static/docs/genindex.html +6390 -0
- simstack/static/docs/index.html +516 -0
- simstack/static/docs/installation.html +553 -0
- simstack/static/docs/lists.html +478 -0
- simstack/static/docs/mass_runner.html +481 -0
- simstack/static/docs/misc.html +454 -0
- simstack/static/docs/objects.inv +0 -0
- simstack/static/docs/overview.html +469 -0
- simstack/static/docs/py-modindex.html +1111 -0
- simstack/static/docs/recovery.html +371 -0
- simstack/static/docs/resource_config.html +590 -0
- simstack/static/docs/search.html +327 -0
- simstack/static/docs/searchindex.js +1 -0
- simstack/static/docs/simstack/modules/modules.html +489 -0
- simstack/static/docs/simstack/modules/simstack.core.html +1883 -0
- simstack/static/docs/simstack/modules/simstack.core.services.html +698 -0
- simstack/static/docs/simstack/modules/simstack.html +3060 -0
- simstack/static/docs/simstack/modules/simstack.methods.html +1150 -0
- simstack/static/docs/simstack/modules/simstack.models.html +13113 -0
- simstack/static/docs/simstack/modules/simstack.tables.html +635 -0
- simstack/static/docs/simstack/modules/simstack.util.html +3320 -0
- simstack/static/docs/submit.html +487 -0
- simstack/static/docs/tables.html +539 -0
- simstack/static/docs/testing_complex_nodes.html +458 -0
- simstack/static/docs/ui_documentation.html +788 -0
- simstack/static/docs/workflows.html +766 -0
- simstack/tables/__init__.py +0 -0
- simstack/tables/model_table.py +191 -0
- simstack/tables/node_children.py +219 -0
- simstack/tables/node_table.py +517 -0
- simstack/tables/table_builder.py +314 -0
- simstack/util/__init__.py +0 -0
- simstack/util/async_zip_utils.py +18 -0
- simstack/util/b64mixin.py +23 -0
- simstack/util/cleaned_json_schema.py +20 -0
- simstack/util/config_reader.py +179 -0
- simstack/util/custom_model_dump.py +75 -0
- simstack/util/database_information.py +160 -0
- simstack/util/db.py +1013 -0
- simstack/util/db_logger.py +117 -0
- simstack/util/default_from_dict.py +57 -0
- simstack/util/directory_iterator.py +216 -0
- simstack/util/docstring_parser.py +186 -0
- simstack/util/file_hashing.py +72 -0
- simstack/util/file_transfer_client.py +427 -0
- simstack/util/files.py +396 -0
- simstack/util/find_python_files.py +33 -0
- simstack/util/generate_ui_schema.py +80 -0
- simstack/util/generic_list_mixin.py +120 -0
- simstack/util/geometry_utils.py +118 -0
- simstack/util/get_module_path.py +20 -0
- simstack/util/git_pull.py +65 -0
- simstack/util/git_repository_status.py +95 -0
- simstack/util/import_module.py +63 -0
- simstack/util/importer.py +312 -0
- simstack/util/init_data_source.py +41 -0
- simstack/util/make_graph.py +107 -0
- simstack/util/make_table.py +837 -0
- simstack/util/mappings.py +41 -0
- simstack/util/minimal_route_finder.py +72 -0
- simstack/util/mock_db.py +144 -0
- simstack/util/module_path_checker.py +38 -0
- simstack/util/object_list_mixin.py +282 -0
- simstack/util/path_manager.py +223 -0
- simstack/util/project_root_finder.py +41 -0
- simstack/util/queue_watcher.py +262 -0
- simstack/util/resource_config.py +198 -0
- simstack/util/route_finder.py +74 -0
- simstack/util/runner_util.py +166 -0
- simstack/util/runner_utils.py +143 -0
- simstack/util/safe_code_executor.py +194 -0
- simstack/util/sample_config.py +98 -0
- simstack/util/sensitive_content_filter.py +48 -0
- simstack/util/setup_logging.py +49 -0
- simstack/util/submit_to_watchdog.py +106 -0
- simstack/util/toml_reader.py +142 -0
- simstack/util/transform_file_name.py +41 -0
- simstack/util/ui_tools.py +213 -0
- simstack-2.0.1.dist-info/METADATA +454 -0
- simstack-2.0.1.dist-info/RECORD +354 -0
- simstack-2.0.1.dist-info/WHEEL +5 -0
- simstack-2.0.1.dist-info/entry_points.txt +12 -0
- simstack-2.0.1.dist-info/licenses/LICENSE +21 -0
- simstack-2.0.1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
/* Project theme overrides placeholder. */
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/*
|
|
2
|
+
This CSS file should be overridden by the theme authors. It's
|
|
3
|
+
meant for debugging and developing the skeleton that this theme provides.
|
|
4
|
+
*/
|
|
5
|
+
body {
|
|
6
|
+
font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif,
|
|
7
|
+
"Apple Color Emoji", "Segoe UI Emoji";
|
|
8
|
+
background: lavender;
|
|
9
|
+
}
|
|
10
|
+
.sb-announcement {
|
|
11
|
+
background: rgb(131, 131, 131);
|
|
12
|
+
}
|
|
13
|
+
.sb-announcement__inner {
|
|
14
|
+
background: black;
|
|
15
|
+
color: white;
|
|
16
|
+
}
|
|
17
|
+
.sb-header {
|
|
18
|
+
background: lightskyblue;
|
|
19
|
+
}
|
|
20
|
+
.sb-header__inner {
|
|
21
|
+
background: royalblue;
|
|
22
|
+
color: white;
|
|
23
|
+
}
|
|
24
|
+
.sb-header-secondary {
|
|
25
|
+
background: lightcyan;
|
|
26
|
+
}
|
|
27
|
+
.sb-header-secondary__inner {
|
|
28
|
+
background: cornflowerblue;
|
|
29
|
+
color: white;
|
|
30
|
+
}
|
|
31
|
+
.sb-sidebar-primary {
|
|
32
|
+
background: lightgreen;
|
|
33
|
+
}
|
|
34
|
+
.sb-main {
|
|
35
|
+
background: blanchedalmond;
|
|
36
|
+
}
|
|
37
|
+
.sb-main__inner {
|
|
38
|
+
background: antiquewhite;
|
|
39
|
+
}
|
|
40
|
+
.sb-header-article {
|
|
41
|
+
background: lightsteelblue;
|
|
42
|
+
}
|
|
43
|
+
.sb-article-container {
|
|
44
|
+
background: snow;
|
|
45
|
+
}
|
|
46
|
+
.sb-article-main {
|
|
47
|
+
background: white;
|
|
48
|
+
}
|
|
49
|
+
.sb-footer-article {
|
|
50
|
+
background: lightpink;
|
|
51
|
+
}
|
|
52
|
+
.sb-sidebar-secondary {
|
|
53
|
+
background: lightgoldenrodyellow;
|
|
54
|
+
}
|
|
55
|
+
.sb-footer-content {
|
|
56
|
+
background: plum;
|
|
57
|
+
}
|
|
58
|
+
.sb-footer-content__inner {
|
|
59
|
+
background: palevioletred;
|
|
60
|
+
}
|
|
61
|
+
.sb-footer {
|
|
62
|
+
background: pink;
|
|
63
|
+
}
|
|
64
|
+
.sb-footer__inner {
|
|
65
|
+
background: salmon;
|
|
66
|
+
}
|
|
67
|
+
.sb-article {
|
|
68
|
+
background: white;
|
|
69
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
.bottom-of-page .right-details {
|
|
2
|
+
display: flex;
|
|
3
|
+
flex: 1 1 auto;
|
|
4
|
+
justify-content: flex-end;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
.docs-build-badge {
|
|
8
|
+
display: inline-flex;
|
|
9
|
+
flex-direction: column;
|
|
10
|
+
gap: 2px;
|
|
11
|
+
min-width: 220px;
|
|
12
|
+
max-width: 340px;
|
|
13
|
+
margin-left: auto;
|
|
14
|
+
padding: 9px 12px;
|
|
15
|
+
border: 1px solid rgba(34, 213, 255, 0.45);
|
|
16
|
+
border-radius: 12px;
|
|
17
|
+
background: linear-gradient(145deg, rgba(19, 39, 56, 0.88), rgba(30, 58, 82, 0.88));
|
|
18
|
+
color: #e9fbff;
|
|
19
|
+
box-shadow: 0 6px 16px rgba(0, 0, 0, 0.28);
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
.docs-build-badge__label {
|
|
23
|
+
font-size: 11px;
|
|
24
|
+
font-weight: 700;
|
|
25
|
+
letter-spacing: 0.08em;
|
|
26
|
+
text-transform: uppercase;
|
|
27
|
+
color: #7ce9ff;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
.docs-build-badge__value {
|
|
31
|
+
font-size: 13px;
|
|
32
|
+
font-weight: 600;
|
|
33
|
+
line-height: 1.3;
|
|
34
|
+
word-break: break-word;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
@media (max-width: 900px) {
|
|
38
|
+
.bottom-of-page .right-details {
|
|
39
|
+
justify-content: flex-start;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
.docs-build-badge {
|
|
43
|
+
min-width: 180px;
|
|
44
|
+
max-width: min(72vw, 320px);
|
|
45
|
+
padding: 8px 10px;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
.docs-build-badge__value {
|
|
49
|
+
font-size: 12px;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
(function () {
|
|
2
|
+
function createBuildBadge() {
|
|
3
|
+
const script =
|
|
4
|
+
document.currentScript ||
|
|
5
|
+
document.querySelector('script[src*="docs-build-badge.js"][data-docs-built-at]');
|
|
6
|
+
|
|
7
|
+
if (!script) {
|
|
8
|
+
return;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
const builtAt = script.getAttribute("data-docs-built-at");
|
|
12
|
+
if (!builtAt || document.getElementById("docs-build-badge")) {
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
const badge = document.createElement("aside");
|
|
17
|
+
badge.id = "docs-build-badge";
|
|
18
|
+
badge.className = "docs-build-badge";
|
|
19
|
+
|
|
20
|
+
const label = document.createElement("span");
|
|
21
|
+
label.className = "docs-build-badge__label";
|
|
22
|
+
label.textContent = "Docs build";
|
|
23
|
+
|
|
24
|
+
const value = document.createElement("span");
|
|
25
|
+
value.className = "docs-build-badge__value";
|
|
26
|
+
value.textContent = builtAt;
|
|
27
|
+
|
|
28
|
+
badge.appendChild(label);
|
|
29
|
+
badge.appendChild(value);
|
|
30
|
+
|
|
31
|
+
const bottom = document.querySelector(".bottom-of-page");
|
|
32
|
+
if (!bottom) {
|
|
33
|
+
return;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
let rightDetails = bottom.querySelector(".right-details");
|
|
37
|
+
if (!rightDetails) {
|
|
38
|
+
rightDetails = document.createElement("div");
|
|
39
|
+
rightDetails.className = "right-details";
|
|
40
|
+
bottom.appendChild(rightDetails);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
rightDetails.appendChild(badge);
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
if (document.readyState === "loading") {
|
|
47
|
+
document.addEventListener("DOMContentLoaded", createBuildBadge, { once: true });
|
|
48
|
+
} else {
|
|
49
|
+
createBuildBadge();
|
|
50
|
+
}
|
|
51
|
+
})();
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Base JavaScript utilities for all Sphinx HTML documentation.
|
|
3
|
+
*/
|
|
4
|
+
"use strict";
|
|
5
|
+
|
|
6
|
+
const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
|
|
7
|
+
"TEXTAREA",
|
|
8
|
+
"INPUT",
|
|
9
|
+
"SELECT",
|
|
10
|
+
"BUTTON",
|
|
11
|
+
]);
|
|
12
|
+
|
|
13
|
+
const _ready = (callback) => {
|
|
14
|
+
if (document.readyState !== "loading") {
|
|
15
|
+
callback();
|
|
16
|
+
} else {
|
|
17
|
+
document.addEventListener("DOMContentLoaded", callback);
|
|
18
|
+
}
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Small JavaScript module for the documentation.
|
|
23
|
+
*/
|
|
24
|
+
const Documentation = {
|
|
25
|
+
init: () => {
|
|
26
|
+
Documentation.initDomainIndexTable();
|
|
27
|
+
Documentation.initOnKeyListeners();
|
|
28
|
+
},
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* i18n support
|
|
32
|
+
*/
|
|
33
|
+
TRANSLATIONS: {},
|
|
34
|
+
PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
|
|
35
|
+
LOCALE: "unknown",
|
|
36
|
+
|
|
37
|
+
// gettext and ngettext don't access this so that the functions
|
|
38
|
+
// can safely bound to a different name (_ = Documentation.gettext)
|
|
39
|
+
gettext: (string) => {
|
|
40
|
+
const translated = Documentation.TRANSLATIONS[string];
|
|
41
|
+
switch (typeof translated) {
|
|
42
|
+
case "undefined":
|
|
43
|
+
return string; // no translation
|
|
44
|
+
case "string":
|
|
45
|
+
return translated; // translation exists
|
|
46
|
+
default:
|
|
47
|
+
return translated[0]; // (singular, plural) translation tuple exists
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
|
|
51
|
+
ngettext: (singular, plural, n) => {
|
|
52
|
+
const translated = Documentation.TRANSLATIONS[singular];
|
|
53
|
+
if (typeof translated !== "undefined")
|
|
54
|
+
return translated[Documentation.PLURAL_EXPR(n)];
|
|
55
|
+
return n === 1 ? singular : plural;
|
|
56
|
+
},
|
|
57
|
+
|
|
58
|
+
addTranslations: (catalog) => {
|
|
59
|
+
Object.assign(Documentation.TRANSLATIONS, catalog.messages);
|
|
60
|
+
Documentation.PLURAL_EXPR = new Function(
|
|
61
|
+
"n",
|
|
62
|
+
`return (${catalog.plural_expr})`,
|
|
63
|
+
);
|
|
64
|
+
Documentation.LOCALE = catalog.locale;
|
|
65
|
+
},
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* helper function to focus on search bar
|
|
69
|
+
*/
|
|
70
|
+
focusSearchBar: () => {
|
|
71
|
+
document.querySelectorAll("input[name=q]")[0]?.focus();
|
|
72
|
+
},
|
|
73
|
+
|
|
74
|
+
/**
|
|
75
|
+
* Initialise the domain index toggle buttons
|
|
76
|
+
*/
|
|
77
|
+
initDomainIndexTable: () => {
|
|
78
|
+
const toggler = (el) => {
|
|
79
|
+
const idNumber = el.id.substr(7);
|
|
80
|
+
const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
|
|
81
|
+
if (el.src.substr(-9) === "minus.png") {
|
|
82
|
+
el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
|
|
83
|
+
toggledRows.forEach((el) => (el.style.display = "none"));
|
|
84
|
+
} else {
|
|
85
|
+
el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
|
|
86
|
+
toggledRows.forEach((el) => (el.style.display = ""));
|
|
87
|
+
}
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
const togglerElements = document.querySelectorAll("img.toggler");
|
|
91
|
+
togglerElements.forEach((el) =>
|
|
92
|
+
el.addEventListener("click", (event) => toggler(event.currentTarget)),
|
|
93
|
+
);
|
|
94
|
+
togglerElements.forEach((el) => (el.style.display = ""));
|
|
95
|
+
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
|
|
96
|
+
},
|
|
97
|
+
|
|
98
|
+
initOnKeyListeners: () => {
|
|
99
|
+
// only install a listener if it is really needed
|
|
100
|
+
if (
|
|
101
|
+
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS
|
|
102
|
+
&& !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
|
|
103
|
+
)
|
|
104
|
+
return;
|
|
105
|
+
|
|
106
|
+
document.addEventListener("keydown", (event) => {
|
|
107
|
+
// bail for input elements
|
|
108
|
+
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName))
|
|
109
|
+
return;
|
|
110
|
+
// bail with special keys
|
|
111
|
+
if (event.altKey || event.ctrlKey || event.metaKey) return;
|
|
112
|
+
|
|
113
|
+
if (!event.shiftKey) {
|
|
114
|
+
switch (event.key) {
|
|
115
|
+
case "ArrowLeft":
|
|
116
|
+
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
|
|
117
|
+
|
|
118
|
+
const prevLink = document.querySelector('link[rel="prev"]');
|
|
119
|
+
if (prevLink && prevLink.href) {
|
|
120
|
+
window.location.href = prevLink.href;
|
|
121
|
+
event.preventDefault();
|
|
122
|
+
}
|
|
123
|
+
break;
|
|
124
|
+
case "ArrowRight":
|
|
125
|
+
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
|
|
126
|
+
|
|
127
|
+
const nextLink = document.querySelector('link[rel="next"]');
|
|
128
|
+
if (nextLink && nextLink.href) {
|
|
129
|
+
window.location.href = nextLink.href;
|
|
130
|
+
event.preventDefault();
|
|
131
|
+
}
|
|
132
|
+
break;
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
// some keyboard layouts may need Shift to get /
|
|
137
|
+
switch (event.key) {
|
|
138
|
+
case "/":
|
|
139
|
+
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
|
|
140
|
+
Documentation.focusSearchBar();
|
|
141
|
+
event.preventDefault();
|
|
142
|
+
}
|
|
143
|
+
});
|
|
144
|
+
},
|
|
145
|
+
};
|
|
146
|
+
|
|
147
|
+
// quick alias for translations
|
|
148
|
+
const _ = Documentation.gettext;
|
|
149
|
+
|
|
150
|
+
_ready(Documentation.init);
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
const DOCUMENTATION_OPTIONS = {
|
|
2
|
+
VERSION: '',
|
|
3
|
+
LANGUAGE: 'en',
|
|
4
|
+
COLLAPSE_INDEX: false,
|
|
5
|
+
BUILDER: 'html',
|
|
6
|
+
FILE_SUFFIX: '.html',
|
|
7
|
+
LINK_SUFFIX: '.html',
|
|
8
|
+
HAS_SOURCE: true,
|
|
9
|
+
SOURCELINK_SUFFIX: '.txt',
|
|
10
|
+
NAVIGATION_WITH_KEYS: false,
|
|
11
|
+
SHOW_SEARCH_SUMMARY: true,
|
|
12
|
+
ENABLE_SEARCH_SHORTCUTS: true,
|
|
13
|
+
};
|