Skip to content

docs: Antora component arcadedb-python with the first slice of pages - #23

Merged
tae898 merged 1 commit into
mainfrom
docs/antora-component
Oct 24, 2026
Merged

tae898 merged 1 commit into
mainfrom
docs/antora-component

Conversation

@tae898

@tae898 tae898 commented Oct 23, 2026 •

Copy link
Copy Markdown
Collaborator

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 only docs/antora.yml and docs/modules/, so docs/superpowers/ is untouched.

What is in this slice

  • docs/antora.yml: component arcadedb-python, title ArcadeDB Python, version: ~ so the URL is /arcadedb-python/, and AsciiDoc attributes pkg-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 to arcadedb is a change in those lines only.
  • docs/modules/ROOT/nav.adoc and four pages:
    • index.adoc: what the bindings are, embedded bindings vs the HTTP driver (with an xref to the HTTP driver page in the arcadedb component), 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(), @rid pagination, SQLScript, openCypher.
  • REUSE.toml: **/*.adoc added 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 of arcadedb-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 raises ArcadeDBError: ... 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-docs worktree and this branch renders arcadedb-python/index.html, installation.html, quickstart.html and how-to/databases-and-queries.html, the nav lists all four, the xrefs and anchors resolve, there are no Antora warnings from this component, and the arcadedb component still builds.

What follows as later PRs

  1. The guide pages (transactions, graphs, graph analytics, vectors, time series, data import, server mode, JVM and logging, known engine issues).
  2. A few short worked examples.
  3. The API reference, generated from the docstrings (as proposed in #502).

🤖 Generated with Claude Code

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant