Add some missing backends to generated docs #14290
Conversation
There was a problem hiding this comment.
So, I'm simplifying by ignoring what we have internally
I don't see that we are.
As the backends are still using --backend-packages=-[..] and ..=+[...] to add/remove entries to what is already configured, right?
IIUC this simply explicitly lists all backends that we do want to have docs generated for, in addition to what is not explicitly excluded from those enabled in pants.toml..?
Oh wait that's why simpler to stop using |
Eric-Arellano
force-pushed
the
google-cloud-function-docs
branch
from
8261664
to
6637089
Compare
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
Eric-Arellano
force-pushed
the
google-cloud-function-docs
branch
from
6637089
to
901ee2d
Compare
| f"--backend-packages=-[{', '.join(map(repr, deactivated_backends))}]", | ||
| f"--backend-packages=+[{', '.join(map(repr, activated_backends))}]", | ||
| "--plugins=[]", | ||
| f"--backend-packages={repr(backends)}", |
There was a problem hiding this comment.
idkay, but I like ..={backends!r}.. being more succinct ;)
| "pants.backend.python.typecheck.mypy", | ||
| "pants.backend.shell", | ||
| "pants.backend.shell.lint.shellcheck", | ||
| "pants.backend.shell.lint.shfmt", | ||
| ] |
There was a problem hiding this comment.
FYI this is the list of backends. Any you think I should add? I left off these:
- src/python/pants/backend/experimental/codegen/avro/java
- src/python/pants/backend/experimental/codegen/protobuf/{java,scala}
- src/python/pants/backend/experimental/codegen/thrift/apache/java
- src/python/pants/backend/experimental/codegen/thrift/scrooge/{java,scala}
- src/python/pants/backend/experimental/debian
- src/python/pants/backend/experimental/go/lint/vet
- src/python/pants/backend/experimental/{java,scala}/debug_goals
- src/python/pants/backend/experimental/python
- src/python/pants/backend/experimental/terraform
pants/src/python/pants/init/BUILD
Lines 9 to 49 in c890ec1
There was a problem hiding this comment.
Perhaps some (if not all) stuff in experimental python would be nice to include.. ?
Unless they're in such a state that not documenting them is preferable.. ?
There was a problem hiding this comment.
It looks like that backend is necessary for Twine and publish to have automated references, which would be good. I don't love that user-generate-lockfiles will also be picked up, but I just finished deprecating that goal, so that's fine with me.
There was a problem hiding this comment.
cc @tdyas as the author of several of these backends
There was a problem hiding this comment.
I'd leave out the non-Python codegen backends for now since there is additional work needed to get them actually working.
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
I discovered we're missing some backends like `google_cloud_function.python`. Our current approach of matching all backends available (`init/BUILD`) against what we activate internally (`pants.toml`) against `generate_docs.py` has proven too error-prone. So, I'm simplifying by ignoring what we have internally and simply listing in `generate_docs.py` everything that is publishable. [ci skip-rust]
…14292) I discovered we're missing some backends like `google_cloud_function.python`. Our current approach of matching all backends available (`init/BUILD`) against what we activate internally (`pants.toml`) against `generate_docs.py` has proven too error-prone. So, I'm simplifying by ignoring what we have internally and simply listing in `generate_docs.py` everything that is publishable. [ci skip-rust]
I discovered we're missing some backends like
google_cloud_function.python.Our current approach of matching all backends available (
init/BUILD) against what we activate internally (pants.toml) againstgenerate_docs.pyhas proven too error-prone. So, I'm simplifying by ignoring what we have internally and simply listing ingenerate_docs.pyeverything that is publishable.