tdfs4ds.docs_location¶
tdfs4ds.docs_location
¶
Where the tdfs4ds documentation (the MkDocs-built site) is, for the app and for a notebook.
The site is built into the repository's docs/ folder (mkdocs build). A source
checkout (or the Docker image, which bind-mounts ./docs) serves that folder, so a
local rebuild shows at once. An installed package carries a copy, tdfs4ds/docs_site,
added by setup.py when the wheel is built (0.3.6.0; before, a pip install had no
documentation at all and the app's docs server started on a missing folder).
docs_dir
¶
The documentation site folder: the source checkout's docs/ when present (the
freshest build, as before 0.3.6.0), else the copy shipped in the package, else None.
docs_path
¶
Absolute path of a documentation page (default the home page), or None when the documentation is not available. Open it in a browser, or see it in the admin app (Help › tdfs4ds guide).