Skip to main content

vdoc

Pipeline Coverage PyVersions PyPI Ruff uv Checked with mypy

Multi version documentation hosting.

See it in action

The vdoc instance serving the voraus robotik GmbH software documentation is available at docs.vorausrobotik.com.

AI and agent ready

Documentation is read by crawlers, link checkers and coding agents as much as by people, and a JavaScript application tells them nothing. vdoc therefore publishes what it holds in three files such a client already looks for, all generated from what is actually published:

/llms.txt Every project at its newest version, linked at the address that serves real HTML, plus the machine-readable page index each version ships
/sitemap.xml The same entry points as a sitemap, dated by when each version was published
/robots.txt Allows everything, and points at both of the above

llms.txt follows the llms.txt convention, sitemap.xml the sitemaps protocol, and robots.txt the Robots Exclusion Protocol (RFC 9309).

A page requested at its readable address answers with a Link header naming the static address that carries it, so a client that started from a link a person shared finds the content from the response it already has. And an agent is told which of the two addresses to quote back: the readable one.

See Agent and crawler discovery for how it works and what it contains.

Documentation

Please read the documentation for more a more detailed introduction.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vdoc-0.27.0.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vdoc-0.27.0-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

Details for the file vdoc-0.27.0.tar.gz.

File metadata

  • Download URL: vdoc-0.27.0.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for vdoc-0.27.0.tar.gz
Algorithm Hash digest
SHA256 2852f0536489080e17b81e16343e58693f31ed1518ab0bf54cdf3e82495125c3
MD5 e7e11f17fbd7aba2b3b22e3c953e348c
BLAKE2b-256 497aa2c0e2f217df6f2e93b8ae95cf5bb953cbf35063854400fbd56df8283982

See more details on using hashes here.

Provenance

The following attestation bundles were made for vdoc-0.27.0.tar.gz:

Publisher: pipeline.yml on vorausrobotik/vdoc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vdoc-0.27.0-py3-none-any.whl.

File metadata

  • Download URL: vdoc-0.27.0-py3-none-any.whl
  • Upload date:
  • Size: 2.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for vdoc-0.27.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17f36f90da46193eebb8e612c26ecb0e7225f0b7c16f1dfb4b4ac650d784ceba
MD5 078df8a4d632b928537de02611173695
BLAKE2b-256 daaabf1ccbb3ee93a9a71859ca156eac5d2f1b1f9cc3a7a15c70e9834e53afc4

See more details on using hashes here.

Provenance

The following attestation bundles were made for vdoc-0.27.0-py3-none-any.whl:

Publisher: pipeline.yml on vorausrobotik/vdoc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.27.0 This release

2 files

0.26.1

2 files

0.26.0

2 files

0.25.0

2 files

0.24.3

2 files

0.24.2

2 files

0.24.1

2 files

0.24.0

2 files

0.23.1

2 files

0.22.0

2 files

0.21.4

2 files

0.21.3

2 files

0.21.2

2 files

0.21.1

2 files

0.21.0

2 files

0.20.0

2 files

0.19.0

2 files

0.18.0

2 files

0.17.1

2 files

0.16.0

2 files

0.15.0

2 files

0.14.0

2 files

0.13.0

2 files

0.12.0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page