11# Gazelle Plugin
22
33[ Gazelle] [ gazelle ] is a build file generator for Bazel projects. It can
4- create new {code} ` BUILD ` or {code} ` BUILD.bazel ` files for a project that
4+ create new ` BUILD ` or ` BUILD.bazel ` files for a project that
55follows language conventions and update existing build files to include new
66sources, dependencies, and options.
77
@@ -11,11 +11,11 @@ Bazel may run Gazelle using the Gazelle rule, or Gazelle may be installed and ru
1111as a command line tool.
1212
1313The {gh-path}` gazelle ` directory contains a plugin for Gazelle
14- that generates {code} ` BUILD ` files content for Python code. When Gazelle is
14+ that generates ` BUILD ` files content for Python code. When Gazelle is
1515run as a command line tool with this plugin, it embeds a Python interpreter
1616resolved during the plugin build. The behavior of the plugin is slightly
1717different with different version of the interpreter as the Python
18- {code} ` stdlib ` changes with every minor version release. Distributors of Gazelle
18+ ` stdlib ` changes with every minor version release. Distributors of Gazelle
1919binaries should, therefore, build a Gazelle binary for each OS+CPU
2020architecture+Minor Python version combination they are targeting.
2121
@@ -25,19 +25,19 @@ older documentation that includes instructions on how to use Gazelle
2525without using bzlmod as your dependency manager.
2626:::
2727
28- [ bzlmod ] : https://docs. bazel.build/versions/5.0.0/bzlmod.html
28+ [ bzlmod ] : https://bazel.build/external/module
2929
30- Gazelle is non-destructive. It will try to leave your edits to {code} ` BUILD `
31- files alone, only making updates to {code} ` py_* ` targets. However it ** will
30+ Gazelle is non-destructive. It will try to leave your edits to ` BUILD `
31+ files alone, only making updates to ` py_* ` targets. However it ** will
3232remove** dependencies that appear to be unused, so it's a good idea to check
3333in your work before running Gazelle so you can easily revert any changes it made.
3434
35- The {code} ` rules_python ` extension assumes some conventions about your Python code.
35+ The ` rules_python ` extension assumes some conventions about your Python code.
3636These are noted in the subsequent documents, and might require changes to your
3737existing code.
3838
39- Note that the {code} ` gazelle ` program has multiple commands. At present, only
40- the {code} ` update ` command (the default) does anything for Python code.
39+ Note that the ` gazelle ` program has multiple commands. At present, only
40+ the ` update ` command (the default) does anything for Python code.
4141
4242
4343``` {toctree}
0 commit comments