Skip to content

feat: add llms.txt to chisel-docs #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asanvaq merged 5 commits into from
May 29, 2026
Merged

feat: add llms.txt to chisel-docs #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f1ed754
feat: add llms.txt to chisel-docs
asanvaq May 22, 2026
d5e6008
Merge branch 'main' into ROCKS-3156-sphinx-llm
asanvaq May 22, 2026
980f1a9
docs: Apply suggestions from code review
asanvaq May 25, 2026
96ed72f
docs: delete content no longer needed.
asanvaq May 25, 2026
03a010d
docs: update based on SP version
asanvaq May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 26 additions & 19 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,34 @@

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXDIR = .sphinx
SPHINXOPTS ?= -c . -d $(SPHINXDIR)/.doctrees -j auto
SPHINXBUILD ?= $(VENVDIR)/bin/sphinx-build
SOURCEDIR = .
BUILDDIR = _build
VENVDIR = $(SPHINXDIR)/venv
PA11Y = $(SPHINXDIR)/node_modules/pa11y/bin/pa11y.js --config $(SPHINXDIR)/pa11y.json
VENV = $(VENVDIR)/bin/activate
TARGET = *
METRICSDIR = $(SOURCEDIR)/.sphinx/metrics
REQPDFPACKS = latexmk fonts-freefont-otf texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended texlive-font-utils texlive-lang-cjk texlive-xetex plantuml xindy tex-gyre dvipng
CONFIRM_SUDO ?= N
VALE_CONFIG = $(SPHINXDIR)/vale.ini
VALEDIR = $(SPHINXDIR)/venv/lib/python*/site-packages/vale
VOCAB_CANONICAL = $(SPHINXDIR)/styles/config/vocabularies/Canonical
SPHINX_HOST ?= 127.0.0.1
SPHINX_PORT ?= 8000
SPHINXDIR = .sphinx
SPHINXOPTS ?= -c . -d $(SPHINXDIR)/.doctrees -j auto
SPHINXBUILD ?= $(VENVDIR)/bin/sphinx-build
SOURCEDIR = .
BUILDDIR = _build
VENVDIR = $(SPHINXDIR)/venv
PA11Y = $(SPHINXDIR)/node_modules/pa11y/bin/pa11y.js --config $(SPHINXDIR)/pa11y.json
VENV = $(VENVDIR)/bin/activate
TARGET = *
METRICSDIR = $(SOURCEDIR)/.sphinx/metrics
REQPDFPACKS = latexmk fonts-freefont-otf texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended texlive-font-utils texlive-lang-cjk texlive-xetex plantuml xindy tex-gyre dvipng
CONFIRM_SUDO ?= N
VALE_CONFIG = $(SPHINXDIR)/vale.ini
VALEDIR = $(SPHINXDIR)/venv/lib/python*/site-packages/vale
VOCAB_CANONICAL = $(SPHINXDIR)/styles/config/vocabularies/Canonical
SPHINX_HOST ?= 127.0.0.1
SPHINX_PORT ?= 8000

# Sphinx options with sphinx-llm artifact generation disabled (for builds where llms.txt is not needed):
SPHINX_OPTS_NOLLM = $(SPHINXOPTS) -D llms_txt_enabled=0

# Put it first so that "make" without argument is like "make help".
help:
@echo
@echo "-------------------------------------------------------------"
@echo "* watch, build and serve the documentation: make run"
@echo "* only build: make html"
@echo "* only build (full, with LLM artifacts): make html"
@echo "* only build (without LLM artifacts): make html-lite"
@echo "* only serve: make serve"
@echo "* clean built doc files: make clean-doc"
@echo "* clean full environment: make clean"
Expand All @@ -44,7 +48,7 @@ help:
@echo "-------------------------------------------------------------"
@echo

.PHONY: help full‑help html epub pdf linkcheck spelling spellcheck woke \
.PHONY: help full‑help html html-lite epub pdf linkcheck spelling spellcheck woke \
vale pa11y run serve install pa11y‑install \
vale‑install pdf‑prep pdf‑prep‑force clean clean‑doc allmetrics \
update lint-md
Expand Down Expand Up @@ -85,6 +89,9 @@ run: install
html: install
. $(VENV); $(SPHINXBUILD) --fail-on-warning --keep-going -b dirhtml "$(SOURCEDIR)" "$(BUILDDIR)" -w $(SPHINXDIR)/warnings.txt $(SPHINXOPTS)

html-lite: install
. $(VENV); $(SPHINXBUILD) --fail-on-warning --keep-going -b dirhtml "$(SOURCEDIR)" "$(BUILDDIR)" -w $(SPHINXDIR)/warnings.txt $(SPHINX_OPTS_NOLLM)

epub: install
. $(VENV); $(SPHINXBUILD) -b epub "$(SOURCEDIR)" "$(BUILDDIR)" -w $(SPHINXDIR)/warnings.txt $(SPHINXOPTS)

Expand Down
15 changes: 15 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@
"sphinx_config_options",
"sphinx_contributor_listing",
"sphinx_filtered_toctree",
"sphinx_llm.txt",
"sphinx_related_links",
"sphinx_roles",
"sphinx_terminal",
Expand Down Expand Up @@ -354,6 +355,20 @@
:class: hclass2
"""

# sphinx-llm config - https://github.com/NVIDIA/sphinx-llm
# Short description of your docs set:
llms_txt_description = (
"This documentation provides guidance for using Chisel, a developer tool "
"for extracting highly customized and specialized slices of Ubuntu "
"packages to create minimal Ubuntu filesystems with a reduced attack surface "
"and a small storage footprint. "
"Ideal for building distroless-like Docker containers."
)
Comment thread
asanvaq marked this conversation as resolved.

# The base URL for references built by sphinx-markdown-builder.
if os.environ.get("READTHEDOCS"):
markdown_http_base = html_baseurl

# Workaround for https://github.com/canonical/canonical-sphinx/issues/34

if "discourse_prefix" not in html_context and "discourse" in html_context:
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ packaging
sphinxcontrib-svg2pdfconverter[CairoSVG]
sphinx-last-updated-by-git
sphinx-sitemap
sphinx-llm

# Vale dependencies
rst2html
Expand Down
Loading