deploy: 652702e

book/authors.html

@@ -9,6 +9,8 @@
 <span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=capi/capi.html>C API</a><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-capi>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=capi/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Wasm Bindings</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=wasm/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=wasm/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
 <span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-wasm>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=wasm/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
+<span class=nav-text>Python Bindings</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=python/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=python/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
+<span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=python/python.html>Python API</a><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-py>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=python/development.html>Development</a><li class=nav-item data-depth=1><a class=nav-link href=python/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Command-line Utility</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=cli/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=cli/install.html>Installation</a><li class=nav-item data-depth=1><a class=nav-link href=cli/build.html>How to Build</a><li class=nav-item data-depth=1><a class=nav-link href=cli/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
 <span class=nav-text>Manual pages</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=cli/man/man1/abcrypt.1.html><code>abcrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=cli/man/man1/abcrypt-encrypt.1.html><code>abcrypt-encrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=cli/man/man1/abcrypt-decrypt.1.html><code>abcrypt-decrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=cli/man/man1/abcrypt-information.1.html><code>abcrypt-information(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=cli/man/man1/abcrypt-help.1.html><code>abcrypt-help(1)</code></a></ul><li class=nav-item data-depth=1><a class=nav-link href=cli/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Format Specification</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=format.html>Abcrypt Encrypted Data Format</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>

book/capi/capi.html

@@ -9,6 +9,8 @@
 <span class=nav-text>API Reference</span><ul class=nav-list><li class="nav-item is-current-page" data-depth=2><a class=nav-link href=capi.html>C API</a><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-capi>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Wasm Bindings</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../wasm/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=../wasm/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
 <span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-wasm>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=../wasm/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
+<span class=nav-text>Python Bindings</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../python/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=../python/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
+<span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=../python/python.html>Python API</a><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-py>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=../python/development.html>Development</a><li class=nav-item data-depth=1><a class=nav-link href=../python/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Command-line Utility</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../cli/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=../cli/install.html>Installation</a><li class=nav-item data-depth=1><a class=nav-link href=../cli/build.html>How to Build</a><li class=nav-item data-depth=1><a class=nav-link href=../cli/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
 <span class=nav-text>Manual pages</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt.1.html><code>abcrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-encrypt.1.html><code>abcrypt-encrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-decrypt.1.html><code>abcrypt-decrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-information.1.html><code>abcrypt-information(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-help.1.html><code>abcrypt-help(1)</code></a></ul><li class=nav-item data-depth=1><a class=nav-link href=../cli/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Format Specification</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../format.html>Abcrypt Encrypted Data Format</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
@@ -81,7 +83,7 @@
 // # Safety
 //
 // Behavior is undefined if any of the following violates the safety conditions
-// of [`slice::from_raw_parts`]:
+// of `slice::from_raw_parts`:
 //
 // - `ciphertext` and `ciphertext_len`.
 // - `passphrase` and `passphrase_len`.
@@ -107,7 +109,7 @@
 // # Safety
 //
 // Behavior is undefined if any of the following violates the safety conditions
-// of [`slice::from_raw_parts`]:
+// of `slice::from_raw_parts`:
 //
 // - `plaintext` and `plaintext_len`.
 // - `passphrase` and `passphrase_len`.
@@ -132,7 +134,7 @@
 // # Safety
 //
 // Behavior is undefined if any of the following violates the safety conditions
-// of [`slice::from_raw_parts`]:
+// of `slice::from_raw_parts`:
 //
 // - `plaintext` and `plaintext_len`.
 // - `passphrase` and `passphrase_len`.
@@ -156,7 +158,7 @@
 // # Safety
 //
 // Behavior is undefined if `buf` and `buf_len` violates the safety conditions
-// of [`slice::from_raw_parts`].
+// of `slice::from_raw_parts`.
 enum abcrypt_error_code abcrypt_error_message(enum abcrypt_error_code error_code,
                                               uint8_t *buf,
                                               uintptr_t buf_len);
@@ -171,7 +173,7 @@
 //
 // # Safety
 //
-// This must not violate the safety conditions of [`Box::from_raw`].
+// This must not violate the safety conditions of `Box::from_raw`.
 void abcrypt_params_free(struct abcrypt_params *params);
 
 // Reads the Argon2 parameters from `ciphertext`.
@@ -189,7 +191,7 @@
 // # Safety
 //
 // Behavior is undefined if `ciphertext` and `ciphertext_len` violates the
-// safety conditions of [`slice::from_raw_parts`].
+// safety conditions of `slice::from_raw_parts`.
 enum abcrypt_error_code abcrypt_params_read(uint8_t *ciphertext,
                                             uintptr_t ciphertext_len,
                                             struct abcrypt_params *params);

book/capi/changelog.html

@@ -9,6 +9,8 @@
 <span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=capi.html>C API</a><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-capi>Rust API</a></ul><li class="nav-item is-current-page" data-depth=1><a class=nav-link href=changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Wasm Bindings</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../wasm/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=../wasm/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
 <span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-wasm>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=../wasm/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
+<span class=nav-text>Python Bindings</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../python/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=../python/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
+<span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=../python/python.html>Python API</a><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-py>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=../python/development.html>Development</a><li class=nav-item data-depth=1><a class=nav-link href=../python/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Command-line Utility</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../cli/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=../cli/install.html>Installation</a><li class=nav-item data-depth=1><a class=nav-link href=../cli/build.html>How to Build</a><li class=nav-item data-depth=1><a class=nav-link href=../cli/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
 <span class=nav-text>Manual pages</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt.1.html><code>abcrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-encrypt.1.html><code>abcrypt-encrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-decrypt.1.html><code>abcrypt-decrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-information.1.html><code>abcrypt-information(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-help.1.html><code>abcrypt-help(1)</code></a></ul><li class=nav-item data-depth=1><a class=nav-link href=../cli/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Format Specification</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../format.html>Abcrypt Encrypted Data Format</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>

book/capi/index.html

@@ -9,6 +9,8 @@
 <span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=capi.html>C API</a><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-capi>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Wasm Bindings</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../wasm/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=../wasm/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
 <span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-wasm>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=../wasm/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
+<span class=nav-text>Python Bindings</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../python/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=../python/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
+<span class=nav-text>API Reference</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=../python/python.html>Python API</a><li class=nav-item data-depth=2><a class=nav-link href=https://docs.rs/abcrypt-py>Rust API</a></ul><li class=nav-item data-depth=1><a class=nav-link href=../python/development.html>Development</a><li class=nav-item data-depth=1><a class=nav-link href=../python/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Command-line Utility</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../cli/index.html>Introduction</a><li class=nav-item data-depth=1><a class=nav-link href=../cli/install.html>Installation</a><li class=nav-item data-depth=1><a class=nav-link href=../cli/build.html>How to Build</a><li class=nav-item data-depth=1><a class=nav-link href=../cli/usage.html>Usage</a><li class=nav-item data-depth=1><button class=nav-item-toggle></button>
 <span class=nav-text>Manual pages</span><ul class=nav-list><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt.1.html><code>abcrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-encrypt.1.html><code>abcrypt-encrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-decrypt.1.html><code>abcrypt-decrypt(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-information.1.html><code>abcrypt-information(1)</code></a><li class=nav-item data-depth=2><a class=nav-link href=../cli/man/man1/abcrypt-help.1.html><code>abcrypt-help(1)</code></a></ul><li class=nav-item data-depth=1><a class=nav-link href=../cli/changelog.html>Changelog</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
 <span class=nav-text>Format Specification</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../format.html>Abcrypt Encrypted Data Format</a></ul><li class=nav-item data-depth=0><button class=nav-item-toggle></button>
@@ -17,4 +19,4 @@
 <a href=../index.html class=home-link></a><nav class=breadcrumbs aria-label=breadcrumbs><ul><li><a href=../index.html>abcrypt</a><li>C API<li><a href=index.html>Introduction</a></ul></nav><div class=edit-this-page><a href=https://github.com/sorairolake/abcrypt/edit/HEAD/docs/book/modules/capi/pages/index.adoc>Edit this Page</a></div></div><div class=content><aside class="toc sidebar" data-title=Contents data-levels=2><div class=toc-menu></div></aside><article class=doc><h1 class=page>C API for abcrypt</h1><div class=paragraph><p><span class=image><a class=image href="https://github.com/sorairolake/abcrypt/actions?query=branch%3Adevelop+workflow%3ACI++"><img src="https://img.shields.io/github/actions/workflow/status/sorairolake/abcrypt/CI.yaml?branch=develop&amp;style=for-the-badge&amp;logo=github&amp;label=CI" alt=CI></a></span>
 <span class=image><a class=image href=https://crates.io/crates/abcrypt-capi><img src="https://img.shields.io/crates/v/abcrypt-capi?style=for-the-badge&amp;logo=rust" alt=Version></a></span>
 <span class=image><a class=image href=https://docs.rs/abcrypt-capi><img src="https://img.shields.io/docsrs/abcrypt-capi?style=for-the-badge&amp;logo=docsdotrs&amp;label=Docs.rs" alt=Docs></a></span>
-<span class=image><img src="https://img.shields.io/crates/l/abcrypt-capi?style=for-the-badge" alt=License></span></div><div class=paragraph><p><strong>abcrypt-wasm</strong> exposes a C API for the <a href=../lib/index.html class="xref page"><code>abcrypt</code></a> crate.</div></article></div></main></div><footer class=footer><p>&copy; 2022&ndash;2024 Shun Sakai &#183; <a href=https://creativecommons.org/licenses/by/4.0/ target=_blank>CC BY 4.0</a><p>Powered by <a href=https://antora.org/ target=_blank>Antora</a> & <a href=https://gitlab.com/antora/antora-ui-default target=_blank>Antora Default UI</a></footer><script id=site-script src=../../_/js/site.js data-ui-root-path=../../_></script><script async src=../../_/js/vendor/highlight.js></script><script src=../../_/js/vendor/lunr.js></script><script src=../../_/js/search-ui.js id=search-ui-script data-site-root-path=../.. data-snippet-length=100 data-stylesheet=../../_/css/search.css></script><script async src=../../search-index.js></script>
+<span class=image><img src="https://img.shields.io/crates/l/abcrypt-capi?style=for-the-badge" alt=License></span></div><div class=paragraph><p><strong>abcrypt-capi</strong> exposes a C API for the <a href=../lib/index.html class="xref page"><code>abcrypt</code></a> crate.</div></article></div></main></div><footer class=footer><p>&copy; 2022&ndash;2024 Shun Sakai &#183; <a href=https://creativecommons.org/licenses/by/4.0/ target=_blank>CC BY 4.0</a><p>Powered by <a href=https://antora.org/ target=_blank>Antora</a> & <a href=https://gitlab.com/antora/antora-ui-default target=_blank>Antora Default UI</a></footer><script id=site-script src=../../_/js/site.js data-ui-root-path=../../_></script><script async src=../../_/js/vendor/highlight.js></script><script src=../../_/js/vendor/lunr.js></script><script src=../../_/js/search-ui.js id=search-ui-script data-site-root-path=../.. data-snippet-length=100 data-stylesheet=../../_/css/search.css></script><script async src=../../search-index.js></script>