site_name: Oxiland
site_description: Safe Rust and Python APIs for RDF models, SPARQL, and streaming RDF I/O on Oxigraph
site_author: Oxiland contributors
site_url: https://oxiland.readthedocs.io/
repo_url: https://github.com/eddiethedean/oxiland
repo_name: eddiethedean/oxiland
edit_uri: edit/main/docs/
copyright: Copyright © Oxiland contributors ยท Apache-2.0 OR MIT
docs_dir: docs
site_dir: site
theme:
name: material
custom_dir: docs/overrides
language: en
logo: assets/images/oxiland-mark.svg
favicon: assets/images/favicon.svg
icon:
repo: fontawesome/brands/github
font: false
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- announce.dismiss
- navigation.instant
- navigation.instant.progress
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.path
- navigation.footer
- navigation.top
- search.suggest
- search.highlight
- search.share
- content.code.copy
- content.code.select
- content.tabs.link
- content.tooltips
- content.action.edit
- content.action.view
plugins:
- search:
lang: en
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
extra_css:
- assets/stylesheets/extra.css
extra_javascript:
- assets/javascripts/site.js
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/eddiethedean/oxiland
name: Oxiland on GitHub
- icon: fontawesome/brands/rust
link: https://crates.io/crates/oxiland
name: Oxiland on crates.io
- icon: fontawesome/brands/python
link: https://pypi.org/project/oxiland/
name: Oxiland on PyPI
generator: false
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
permalink_title: Link to this section
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.snippets:
base_path:
- .
- ..
check_paths: true
validation:
omitted_files: warn
absolute_links: relative_to_docs
unrecognized_links: warn
anchors: warn
nav:
- Home: index.md
- Python:
- Overview: users/python.md
- Installation and compatibility: users/python-installation.md
- Models and RDF terms: users/python-models.md
- RDF I/O and SPARQL: users/python-data.md
- Production operations: users/python-production.md
- API reference: users/python-api.md
- Examples: users/examples.md
- Rust:
- Overview: users/rust.md
- Getting started: users/getting-started.md
- Examples: users/examples.md
- RDF I/O: users/io.md
- SPARQL: users/sparql.md
- Persistence: users/persistence.md
- Streams: users/streams.md
- Utilities and logging: users/utilities.md
- Production operations: users/rust-production.md
- API reference: https://docs.rs/oxiland
- Command line:
- CLI guide: users/cli.md
- C ABI:
- C ABI guide: users/c-abi.md
- Limitations: users/c-abi-limitations.md
- Help:
- FAQ: users/faq.md
- Known limitations: users/limitations.md
- Upgrading: users/upgrading.md
- Support: support.md
- Security: security.md
- Performance: users/performance.md
- Evaluators:
- Positioning: evaluators/positioning.md
- Migration from Redland: evaluators/migration-from-redland.md
- Redland symbol map: evaluators/redland-symbol-map.md
- Compatibility contract: COMPATIBILITY.md
- Parity ledger: parity.md
- Performance report (0.13): reports/0.13.md
- 0.13.0 release checklist: reports/0.13.0-release.md
- Performance report (0.12): reports/0.12.md
- Milestone 0.13: milestones/0.13.md
- Milestone 0.12: milestones/0.12.md
- Parity report (0.11): reports/0.11.md
- 0.12.0 release checklist: reports/0.12.0-release.md
- 0.11.0 release checklist: reports/0.11.0-release.md
- Milestone 0.11: milestones/0.11.md
- Project:
- Community:
- Code of conduct: code-of-conduct.md
- Contributing: contributing.md
- Direction:
- Project charter: CHARTER.md
- Roadmap: ROADMAP.md
- Storage backend plan: design/storage-backend-expansion.md
- Engineering:
- Architecture: ARCHITECTURE.md
- SOLID boundaries: design/solid-boundaries.md
- Execution: EXECUTION.md
- Verification: VERIFICATION.md
- Decisions: DECISIONS.md
- Risks: RISKS.md
- Archive:
- 0.10 qualification scaffold: reports/0.10.md
- 0.10.0 release checklist: reports/0.10.0-release.md
- Milestone 0.10: milestones/0.10.md
- 0.8 compatibility report: reports/0.8.md
- 0.8.0 release checklist: reports/0.8.0-release.md
- 0.9 compatibility report: reports/0.9.md
- 0.9.0 release checklist: reports/0.9.0-release.md
- 0.9 performance: reports/0.9-performance.md
- Design 0.9 storage evaluations: design/0.9-storage-evaluations.md
- 0.7 compatibility report: reports/0.7.md
- 0.7.0 release checklist: reports/0.7.0-release.md
- 0.6 compatibility report: reports/0.6.md
- 0.6.0 release checklist: reports/0.6.0-release.md
- 0.6 API review: reports/0.6-api-review.md
- Milestone 0.9: milestones/0.9.md
- Milestone 0.8: milestones/0.8.md
- Milestone 0.7: milestones/0.7.md
- Milestone 0.6: milestones/0.6.md
- Milestone 0.5: milestones/0.5.md
- Milestone 0.4: milestones/0.4.md
- Milestone 0.3: milestones/0.3.md
- Milestone 0.2: milestones/0.2.md
- 0.5 compatibility report: reports/0.5.md
- 0.5.0 release checklist: reports/0.5.0-release.md
- 0.4 compatibility report: reports/0.4.md
- 0.4.0 release checklist: reports/0.4.0-release.md
- 0.3 compatibility report: reports/0.3.md
- 0.3.0 release checklist: reports/0.3.0-release.md
- 0.2 compatibility report: reports/0.2.md
- 0.2.0 release checklist: reports/0.2.0-release.md
- 0.1 compatibility report: reports/0.1.md
- 0.1.0 release checklist: reports/0.1.0-release.md
- Design 0.9 C ABI: design/0.9-cabi.md
- Design 0.8 C ABI: design/0.8-cabi.md
- Design 0.8 redb spike: design/0.8-redb-spike.md
- Design 0.7 Python API: design/0.7-python-api.md
- Design 0.6 safe-API accounting: design/0.6-safe-api-accounting.md
- Design 0.6 CLI: design/0.6-cli-rdfproc.md
- Design 0.5 streams/utilities: design/0.5-streams-utilities.md
- Design 0.4 storage API: design/0.4-storage-api.md
- Design 0.4 legacy storage: design/0.4-legacy-storage.md
- Design 0.3 query API: design/0.3-query-api.md
- Design 0.2 I/O API: design/0.2-io-api.md