← Back to issue list

build(docs): exclude `reuse` dir

View original Github issue

Metadata

Project
starbase
Number
#483
Type
pull request
State
merged
Author
medubelko
Labels
Created
Updated
Closed

Current evaluation

Merged to exclude the docs/reuse directory from Sphinx builds, preventing search engines from indexing stub rst files. Approved by two reviewers and passed all CI checks.

Suggested action:

No scores available.

Issue body

Stop Sphinx from building files in the `docs/reuse` dir. Many of our apps use this dir, and some put `.rst` files in there, which Sphinx greedily builds. If they end up published, search engines then crawl and index those stubs as if they were real pages. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/starbase/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation. - [x] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged to exclude the docs/reuse directory from Sphinx builds, preventing search engines from indexing stub rst files. Approved by two reviewers and passed all CI checks.
qwen3.6-35b-a3b-mtp-q6 Merged configuration to exclude the docs/reuse directory from Sphinx builds. This prevents search engines from indexing stub rst files in the shared directory as published pages.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#924 docs: exclude reuse dir from search results rockcraft merged Merged. Excludes the reuse directory from search results by removing it from the node graph. Approved by two reviewers and passed CI checks.
79%
#920 docs: add common page 'reuse packages between builds' craft-application merged Merged documentation update adding a page on reusing packages between builds. Also removes the docs linter line length check and adds sphinx-substitution-extensions as a dependency. Approved by two reviewers with all CI checks passing.
72%
#1247 docs: exclude 'including local files and remote resources' from build rockcraft merged Merged a single-line documentation update that excludes a file from the build. This prevents a duplicate in the common folder from appearing in site search results. Approved by one reviewer with all CI checks passing.
71%