feat(template): drop docs-site, fold audience/visibility into one open_source question#327
Merged
Merged
Conversation
…n_source question Remove the generated documentation site entirely: zensical, mkdocstrings, the docs/ tree, the Pages workflow and GitLab pages job, the docs-build hook and all related dependencies. A scaffolded project now keeps a README and CHANGELOG; published docs are the user's own responsibility once a project actually has an audience. Collapse the public/private axis — previously asked three times via project_audience, project_visibility and use_community_health_files — into a single open_source question that gates the LICENSE and community-health files. It defaults to true on GitHub, false elsewhere. Remaining opinions stay opinionated with static defaults: CI on, heavy hooks off.
Member
Author
|
This change is part of the following stack: Change managed by git-spice. |
ApprovabilityVerdict: Needs human review This PR removes the docs-site feature entirely and consolidates multiple configuration questions into a single You can customize Macroscope's approvability policy. Learn more. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove the generated documentation site entirely: zensical, mkdocstrings,
the docs/ tree, the Pages workflow and GitLab pages job, the docs-build hook
and all related dependencies. A scaffolded project now keeps a README and
CHANGELOG; published docs are the user's own responsibility once a project
actually has an audience.
Collapse the public/private axis — previously asked three times via
project_audience, project_visibility and use_community_health_files — into a
single open_source question that gates the LICENSE and community-health files.
It defaults to true on GitHub, false elsewhere.
Remaining opinions stay opinionated with static defaults: CI on, heavy hooks off.
Closes #
Note
Drop docs-site scaffolding and replace audience/visibility questions with a single
open_sourceflag in the project templateproject_audience,project_visibility,use_community_health_files, anduse_docsquestions from copier.yml, replacing them with a singleopen_sourceboolean (defaults totruewhenrepository_provider == 'github.com').pyproject.toml, and PyPI publishing defaults onopen_source.use_cidefault totrueanduse_heavy_hooksdefault tofalse; heavy hooks now only cover coverage, not docs builds.project_visibility,use_docs, oruse_community_health_filesanswers will need to migrate to the newopen_sourceflag.Macroscope summarized d8507d3.