Repository navigation
docs: Antora component arcadedb-python with the first slice of pages - #23
Merged
Merged
Conversation
Adds docs/antora.yml (component arcadedb-python, unversioned) and a first slice of AsciiDoc pages: index, installation, quickstart and a how-to on databases and queries. The distribution and import names are AsciiDoc attributes in antora.yml. Adds *.adoc to the REUSE annotation. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 23, 2026
Add the arcadedb-python component as a content source and rebuild daily
ArcadeData/arcadedb-docs#505
Merged
Merged
Merged
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of ArcadeData/arcadedb-docs#502 and #19. This is the concrete form of the separate-component proposal in the second comment of that issue: the AsciiDoc of the Python bindings lives here under
docs/, next to the code, and the docs site picks it up as a second content source (the playbook change is ArcadeData/arcadedb-docs#505). Antora reads onlydocs/antora.ymlanddocs/modules/, sodocs/superpowers/is untouched.What is in this slice
docs/antora.yml: componentarcadedb-python, titleArcadeDB Python,version: ~so the URL is/arcadedb-python/, and AsciiDoc attributespkg-name,import-name,import-stmt,native-pkg-name,native-import-name,repo-url,pypi-url. Every page takes the names from them, so the planned rename of the distribution toarcadedbis a change in those lines only.docs/modules/ROOT/nav.adocand four pages:index.adoc: what the bindings are, embedded bindings vs the HTTP driver (with an xref to the HTTP driver page in thearcadedbcomponent), JVM build (default) vs the native preview, requirements, links.installation.adoc: install, platforms, what is included, verify, JVM options, the native preview.quickstart.adoc: first database, transactions, reopening, server mode.how-to/databases-and-queries.adoc: create, open, check and drop a database, locking, parameters,first()/to_list(),@ridpagination, SQLScript, openCypher.REUSE.toml:**/*.adocadded to the annotated paths so the new files carry the same licence annotation as the Markdown.Where the content comes from. The pages are rewritten in AsciiDoc from the MkDocs sources in
humemai/arcadedb-embedded-python(bindings/python/docs/:index.md,getting-started/*,api-access-methods.md,guide/core/database.md,guide/core/queries.md) and, for the native build, from the PyPI description ofarcadedb-embedded-native. Each page starts with a comment naming its sources. There are no performance numbers, and no sizes from the source pages either.Every code sample was run against the published wheel (
uv run --no-project --with arcadedb-embedded==26.10.2.post1 python sample.py, an empty directory per script), and the output under each sample is what it printed on standard output. Two things the run changed against the source pages:open_database(..., read_only=True)is documented in the MkDocs pages but is not in the 26.10.2.post1 wheel (TypeError), so it is left out until a release has it; and a write outside a transaction raisesArcadeDBError: ... TransactionException: Transaction not begun, which the quickstart now shows as run.Checked locally. An Antora build with a temporary playbook whose sources are the
arcadedb-docsworktree and this branch rendersarcadedb-python/index.html,installation.html,quickstart.htmlandhow-to/databases-and-queries.html, the nav lists all four, the xrefs and anchors resolve, there are no Antora warnings from this component, and thearcadedbcomponent still builds.What follows as later PRs
🤖 Generated with Claude Code