Skip to content

Commit 63547de

Browse files
chore: remove generated docs (#673)
Stardoc is a pain in the butt because of its transitive deps. It also makes a bad contributor experience when a minor .bzl fix results in a red PR forcing you to run stardoc on your machine. The next release will have docs on the BCR instead. --------- Co-authored-by: aspect-marvin[bot] <[email protected]>
1 parent 84f5644 commit 63547de

18 files changed

+6
-688
lines changed

.gitattributes

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
docs/*.md linguist-generated=true
2-
docs/migrating.md linguist-generated=false
3-
docs/virtual_deps.md linguist-generated=false
4-
51
# Configuration for 'git archive'
62
# see https://git-scm.com/docs/git-archive/2.40.0#ATTRIBUTES
73
# Don't include examples in the distribution artifact, just to reduce size

.pre-commit-config.yaml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,6 @@ repos:
3434
3535
- repo: local
3636
hooks:
37-
- id: check-docs
38-
name: Update docs
39-
entry: /usr/bin/env bazel run //docs:update
40-
language: script
41-
require_serial: true
42-
4337
- id: check-requirements-lock
4438
name: Update requirements lock
4539
# Note that we use a nested shell to discard $@, which is the file list

.prettierignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +0,0 @@
1-
docs/*.md

README.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,19 +71,7 @@ In any ancestor `BUILD` file of the Python code, add these lines to instruct [Ga
7171

7272
# Public API
7373

74-
## Executables
75-
76-
- [py_binary](docs/py_binary.md) an executable Python program, used with `bazel run` or as a tool.
77-
- [py_test](docs/py_test.md) a Python program that executes a test runner such as `unittest` or `pytest`, to be used with `bazel test`.
78-
- [py_venv](docs/venv.md) create a virtualenv for a `py_binary` or `py_test` target for use outside Bazel, such as in an editor/IDE.
79-
80-
## Packaging
81-
82-
- [py_pex_binary](docs/pex.md) Create a zip file containing a full Python application.
83-
84-
## Packages
85-
86-
- [py_library](docs/py_library.md) a unit of Python code, used as a dependency of other rules.
74+
See https://registry.bazel.build/docs/aspect_rules_py
8775

8876
# Telemetry & privacy policy
8977

docs/BUILD.bazel

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/pex.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/py_binary.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

docs/py_image_layer.md

Lines changed: 0 additions & 86 deletions
This file was deleted.

0 commit comments

Comments
 (0)