Local documentation

Keywords

documentation, cli, agents, offline

Install the optional command-line dependencies in your project’s environment:

python -m pip install "dascore[agents]"

The CLI uses Typer. Importing and using DASCore from Python does not require this extra.

Use the documentation that ships with the DASCore installed in your project’s Python environment:

python -m dascore doc
python -m dascore doc Patch.select
python -m dascore doc Spool.chunk
python -m dascore doc Patch.viz.waterfall
python -m dascore doc recipes/tunnel_inventory

The equivalent console command is dascore doc. Running it without a target reports the DASCore version, Python executable, imported package location, and documentation directory. For repeated agent or notebook work, use the reported Python executable with -m dascore to keep using the same environment.

The first request prepares a directory of Markdown files from the packaged tutorials, recipes, and installed API docstrings. Examples remain unevaluated. Documentation text is available offline; images are excluded from package downloads and linked to hosted copies on GitHub. Image links use the installed release tag or development commit when available, falling back to the dev branch for development versions without commit metadata. API pages include their defining module and signatures when available; unbound method signatures include the instance parameter.

DASCore stores this corpus below its OS-specific user cache, in docs/<DASCore version>/. Subsequent commands reuse it. Changes to an editable installation’s source invalidate the corpus even when its version string stays the same. To regenerate it explicitly:

python -m dascore doc --rebuild

The docs_cache_dir configuration setting controls the cache root for calls in a Python process. The default follows Pooch’s OS-specific DASCore cache location. Generated Markdown can also be opened directly in a text editor.

The local API corpus covers core objects, processing, transforms, visualization, built-in namespaces, and selected public utilities. External plugins and format-specific APIs are outside this initial corpus. Documentation generation inspects Python objects and imports the supported modules, but does not instantiate data objects or execute their operations. Missing optional modules are reported in the corpus summary.

Module pages can be selected explicitly, for example dascore doc module:dascore.viz.waterfall. When a module re-exports a same-named function, its public attribute name selects the function.

Use exact public names such as Inventory, PatchAttrs.tag, or dascore.proc.coords.select. Authored pages use identifiers such as tutorial/patch. Unknown or ambiguous names produce an error and a nonzero exit status. Document output uses UTF-8, including when redirected to a file.