Docs update: 75ce95a

[email protected] [code style][tools] Suppress unnecessary warnings generated by clang-tidy (#945)
intel · May 29, 2024 · 755cf2c · 755cf2c
1 parent 5bd3ddf
commit 755cf2c
Show file tree

Hide file tree

Showing 121 changed files with 2,221 additions and 2,206 deletions.
diff --git a/.doctrees/documentation/bench_docs/guide.doctree b/.doctrees/documentation/bench_docs/guide.doctree
diff --git a/.doctrees/documentation/bench_docs/quick_start.doctree b/.doctrees/documentation/bench_docs/quick_start.doctree
diff --git a/.doctrees/documentation/contributing_docs/issue_reporting.doctree b/.doctrees/documentation/contributing_docs/issue_reporting.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/advanced/c_advanced_topics.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/advanced/c_advanced_topics.doctree
diff --git a/...es/documentation/dev_guide_docs/c_use_cases/advanced/c_advanced_topics_decompress.doctree b/...es/documentation/dev_guide_docs/c_use_cases/advanced/c_advanced_topics_decompress.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/advanced/c_advanced_topics_filter.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/advanced/c_advanced_topics_filter.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/c_asynchronous_execution.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/c_asynchronous_execution.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/c_huffman_only.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/c_huffman_only.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/c_job_structure.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/c_job_structure.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/c_use_huffman_tables.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/c_use_huffman_tables.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_compression.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_compression.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_decompression.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_decompression.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_dictionary.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_dictionary.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_indexing.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_indexing.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_indexing_format.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_indexing_format.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_indexing_usage.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_indexing_usage.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_multiple_jobs.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_multiple_jobs.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_zlib_gzip.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/deflate/c_deflate_zlib_gzip.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations.doctree
diff --git a/...trees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_aggregates.doctree b/...trees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_aggregates.doctree
diff --git a/...mentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_hw_path_optimization.doctree b/...mentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_hw_path_optimization.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_crc64.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_crc64.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_expand.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_expand.doctree
diff --git a/...trees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_extract.doctree b/...trees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_extract.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_scan.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_scan.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_select.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_op_select.doctree
diff --git a/...umentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_output_modification.doctree b/...umentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_output_modification.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_parsers.doctree b/.doctrees/documentation/dev_guide_docs/c_use_cases/filter_ops/c_operations_parsers.doctree
diff --git a/.doctrees/documentation/dev_guide_docs/low_level_developer_guide.doctree b/.doctrees/documentation/dev_guide_docs/low_level_developer_guide.doctree
diff --git a/.doctrees/documentation/dev_ref_docs/c_ref/c_common_definitions.doctree b/.doctrees/documentation/dev_ref_docs/c_ref/c_common_definitions.doctree
diff --git a/.doctrees/documentation/dev_ref_docs/c_ref/c_huffman_table_apis.doctree b/.doctrees/documentation/dev_ref_docs/c_ref/c_huffman_table_apis.doctree
diff --git a/.doctrees/documentation/dev_ref_docs/c_ref/c_job_apis.doctree b/.doctrees/documentation/dev_ref_docs/c_ref/c_job_apis.doctree
diff --git a/.doctrees/documentation/dev_ref_docs/c_ref/c_status_codes.doctree b/.doctrees/documentation/dev_ref_docs/c_ref/c_status_codes.doctree
diff --git a/.doctrees/documentation/dev_ref_docs/low_level_api.doctree b/.doctrees/documentation/dev_ref_docs/low_level_api.doctree
diff --git a/.doctrees/documentation/get_started_docs/code_examples.doctree b/.doctrees/documentation/get_started_docs/code_examples.doctree
diff --git a/.doctrees/documentation/get_started_docs/compression_decompression.doctree b/.doctrees/documentation/get_started_docs/compression_decompression.doctree
diff --git a/.doctrees/documentation/get_started_docs/filter_and_other_operations.doctree b/.doctrees/documentation/get_started_docs/filter_and_other_operations.doctree
diff --git a/.doctrees/documentation/get_started_docs/installation.doctree b/.doctrees/documentation/get_started_docs/installation.doctree
diff --git a/.doctrees/documentation/get_started_docs/quick_start.doctree b/.doctrees/documentation/get_started_docs/quick_start.doctree
diff --git a/.doctrees/documentation/get_started_docs/testing.doctree b/.doctrees/documentation/get_started_docs/testing.doctree
diff --git a/.doctrees/documentation/introduction_docs/introduction.doctree b/.doctrees/documentation/introduction_docs/introduction.doctree
diff --git a/.doctrees/documentation/introduction_docs/legal.doctree b/.doctrees/documentation/introduction_docs/legal.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/_static/scripts/bootstrap.js b/_static/scripts/bootstrap.js
diff --git a/_static/scripts/bootstrap.js.LICENSE.txt b/_static/scripts/bootstrap.js.LICENSE.txt
@@ -1,5 +1,5 @@
 /*!
-  * Bootstrap v5.3.2 (https://getbootstrap.com/)
-  * Copyright 2011-2023 The Bootstrap Authors (https://github.com/twbs/bootstrap/graphs/contributors)
+  * Bootstrap v5.3.3 (https://getbootstrap.com/)
+  * Copyright 2011-2024 The Bootstrap Authors (https://github.com/twbs/bootstrap/graphs/contributors)
   * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
   */
diff --git a/_static/scripts/bootstrap.js.map b/_static/scripts/bootstrap.js.map
diff --git a/_static/scripts/pydata-sphinx-theme.js b/_static/scripts/pydata-sphinx-theme.js
diff --git a/_static/scripts/pydata-sphinx-theme.js.map b/_static/scripts/pydata-sphinx-theme.js.map
diff --git a/_static/styles/bootstrap.css b/_static/styles/bootstrap.css
diff --git a/_static/styles/bootstrap.css.map b/_static/styles/bootstrap.css.map
diff --git a/_static/styles/pydata-sphinx-theme.css b/_static/styles/pydata-sphinx-theme.css
diff --git a/_static/styles/pydata-sphinx-theme.css.map b/_static/styles/pydata-sphinx-theme.css.map
diff --git a/_static/vendor/fontawesome/6.5.1/css/all.min.css b/_static/vendor/fontawesome/6.5.1/css/all.min.css
diff --git a/_static/vendor/fontawesome/6.5.1/js/all.min.js b/_static/vendor/fontawesome/6.5.1/js/all.min.js
diff --git a/_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2 b/_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2
diff --git a/_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2 b/_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2
diff --git a/_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2 b/_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2
diff --git a/_static/vendor/fontawesome/6.5.1/webfonts/fa-v4compatibility.woff2 b/_static/vendor/fontawesome/6.5.1/webfonts/fa-v4compatibility.woff2
diff --git a/_static/vendor/fontawesome/6.5.1/LICENSE.txt → _static/vendor/fontawesome/6.5.2/LICENSE.txt b/_static/vendor/fontawesome/6.5.1/LICENSE.txt → _static/vendor/fontawesome/6.5.2/LICENSE.txt
@@ -23,7 +23,7 @@ as SVG and JS file types.
 In the Font Awesome Free download, the SIL OFL license applies to all icons
 packaged as web and desktop font files.
 
-Copyright (c) 2023 Fonticons, Inc. (https://fontawesome.com)
+Copyright (c) 2024 Fonticons, Inc. (https://fontawesome.com)
 with Reserved Font Name: "Font Awesome".
 
 This Font Software is licensed under the SIL Open Font License, Version 1.1.
@@ -123,7 +123,7 @@ OTHER DEALINGS IN THE FONT SOFTWARE.
 In the Font Awesome Free download, the MIT license applies to all non-font and
 non-icon files.
 
-Copyright 2023 Fonticons, Inc.
+Copyright 2024 Fonticons, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in the

diff --git a/_static/vendor/fontawesome/6.5.2/css/all.min.css b/_static/vendor/fontawesome/6.5.2/css/all.min.css
diff --git a/_static/vendor/fontawesome/6.5.2/js/all.min.js b/_static/vendor/fontawesome/6.5.2/js/all.min.js
diff --git a/...ntawesome/6.5.1/js/all.min.js.LICENSE.txt → ...ntawesome/6.5.2/js/all.min.js.LICENSE.txt b/...ntawesome/6.5.1/js/all.min.js.LICENSE.txt → ...ntawesome/6.5.2/js/all.min.js.LICENSE.txt
@@ -1,5 +1,5 @@
 /*!
- * Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com
+ * Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com
  * License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
- * Copyright 2023 Fonticons, Inc.
+ * Copyright 2024 Fonticons, Inc.
  */
diff --git a/...tawesome/6.5.1/webfonts/fa-brands-400.ttf → ...tawesome/6.5.2/webfonts/fa-brands-400.ttf b/...tawesome/6.5.1/webfonts/fa-brands-400.ttf → ...tawesome/6.5.2/webfonts/fa-brands-400.ttf
diff --git a/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2 b/_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2
diff --git a/...awesome/6.5.1/webfonts/fa-regular-400.ttf → ...awesome/6.5.2/webfonts/fa-regular-400.ttf b/...awesome/6.5.1/webfonts/fa-regular-400.ttf → ...awesome/6.5.2/webfonts/fa-regular-400.ttf
diff --git a/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2 b/_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2
diff --git a/...ntawesome/6.5.1/webfonts/fa-solid-900.ttf → ...ntawesome/6.5.2/webfonts/fa-solid-900.ttf b/...ntawesome/6.5.1/webfonts/fa-solid-900.ttf → ...ntawesome/6.5.2/webfonts/fa-solid-900.ttf
diff --git a/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2 b/_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2
diff --git a/...ome/6.5.1/webfonts/fa-v4compatibility.ttf → ...ome/6.5.2/webfonts/fa-v4compatibility.ttf b/...ome/6.5.1/webfonts/fa-v4compatibility.ttf → ...ome/6.5.2/webfonts/fa-v4compatibility.ttf
diff --git a/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2 b/_static/vendor/fontawesome/6.5.2/webfonts/fa-v4compatibility.woff2
diff --git a/_static/webpack-macros.html b/_static/webpack-macros.html
@@ -4,28 +4,28 @@
 -->
 {# Load FontAwesome icons #}
 {% macro head_pre_icons() %}
-  <link href="{{ pathto('_static/vendor/fontawesome/6.5.1/css/all.min.css', 1) }}?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
-  <link rel="preload" as="font" type="font/woff2" crossorigin href="{{ pathto('_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2', 1) }}" />
-<link rel="preload" as="font" type="font/woff2" crossorigin href="{{ pathto('_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2', 1) }}" />
-<link rel="preload" as="font" type="font/woff2" crossorigin href="{{ pathto('_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2', 1) }}" />
+  <link href="{{ pathto('_static/vendor/fontawesome/6.5.2/css/all.min.css', 1) }}?digest=3ee479438cf8b5e0d341" rel="stylesheet" />
+  <link rel="preload" as="font" type="font/woff2" crossorigin href="{{ pathto('_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2', 1) }}" />
+<link rel="preload" as="font" type="font/woff2" crossorigin href="{{ pathto('_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2', 1) }}" />
+<link rel="preload" as="font" type="font/woff2" crossorigin href="{{ pathto('_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2', 1) }}" />
 {% endmacro %}
 
 {% macro head_pre_assets() %}
   <!-- Loaded before other Sphinx assets -->
-  <link href="{{ pathto('_static/styles/theme.css', 1) }}?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
-<link href="{{ pathto('_static/styles/bootstrap.css', 1) }}?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
-<link href="{{ pathto('_static/styles/pydata-sphinx-theme.css', 1) }}?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
+  <link href="{{ pathto('_static/styles/theme.css', 1) }}?digest=3ee479438cf8b5e0d341" rel="stylesheet" />
+<link href="{{ pathto('_static/styles/bootstrap.css', 1) }}?digest=3ee479438cf8b5e0d341" rel="stylesheet" />
+<link href="{{ pathto('_static/styles/pydata-sphinx-theme.css', 1) }}?digest=3ee479438cf8b5e0d341" rel="stylesheet" />
 {% endmacro %}
 
 {% macro head_js_preload() %}
   <!-- Pre-loaded scripts that we'll load fully later -->
-  <link rel="preload" as="script" href="{{ pathto('_static/scripts/bootstrap.js', 1) }}?digest=8d27b9dea8ad943066ae" />
-<link rel="preload" as="script" href="{{ pathto('_static/scripts/pydata-sphinx-theme.js', 1) }}?digest=8d27b9dea8ad943066ae" />
-  <script src="{{ pathto('_static/vendor/fontawesome/6.5.1/js/all.min.js', 1) }}?digest=8d27b9dea8ad943066ae"></script>
+  <link rel="preload" as="script" href="{{ pathto('_static/scripts/bootstrap.js', 1) }}?digest=3ee479438cf8b5e0d341" />
+<link rel="preload" as="script" href="{{ pathto('_static/scripts/pydata-sphinx-theme.js', 1) }}?digest=3ee479438cf8b5e0d341" />
+  <script src="{{ pathto('_static/vendor/fontawesome/6.5.2/js/all.min.js', 1) }}?digest=3ee479438cf8b5e0d341"></script>
 {% endmacro %}
 
 {% macro body_post() %}
   <!-- Scripts loaded after <body> so the DOM is not blocked -->
-  <script src="{{ pathto('_static/scripts/bootstrap.js', 1) }}?digest=8d27b9dea8ad943066ae"></script>
-<script src="{{ pathto('_static/scripts/pydata-sphinx-theme.js', 1) }}?digest=8d27b9dea8ad943066ae"></script>
+  <script src="{{ pathto('_static/scripts/bootstrap.js', 1) }}?digest=3ee479438cf8b5e0d341"></script>
+<script src="{{ pathto('_static/scripts/pydata-sphinx-theme.js', 1) }}?digest=3ee479438cf8b5e0d341"></script>
 {% endmacro %}