| commit | 327b4e368b1b905d1b379a0592e89250e70a34c6 | [log] [tgz] |
|---|---|---|
| author | Richard Levasseur <rlevasseur@google.com> | Thu Oct 19 11:03:01 2023 -0700 |
| committer | GitHub <noreply@github.com> | Thu Oct 19 18:03:01 2023 +0000 |
| tree | 568482a9dcdaa2b509f7d3ef03536e62c7d9a915 | |
| parent | a9a0e59513933dade0dda8d58a76c4d521e3b6ea [diff] |
docs: make readthedocs render a bit nicer and port docs over to Sphinx (#1511) This makes the Sphinx-based docs hosted on readthedocs render a bit more nicely, fixes a few issues, and adds some features to //sphinxdocs This also moves all the docs onto Sphinx, deleting the checked-in documentation. Doc fixes/improvements: * Ports various docs over to Sphinx pages. They're split out from the readme file. * Version RTD is building is reflected in the docs * Fixes some references to github files * Includes the custom CSS file that styled the api docs * Removes `-Q` from doc building; all warnings should be fixed now * Added Bazel inventory file. Bazel doesn't provide one, but we can manually provide on and still use intersphinx functionality. * Added `gh-path` custom role. This is a shortcut for writing the whole github URL. * Sets the primary domain to None. The default is py, which we don't use much of, so it just results in confusing crossref errors. * Enable nitpicky mode to catch more errors. * Remove the `starlark` marker from codeblocks; that name isn't recognized by Sphinx. The highlighting is still sufficient. * Adds a glossary Sphinxdocs improvements: * Added a flag to pass along arbitrary `-D` args to the Sphinx invocations. This allows e.g., the `version` setting of the docs to be set on the command line from the `READTHEDOCS_VERSION` environment variable * Added inventory file generation. These are files that allow referencing external projects using intersphinx. * `sphinx_stardocs` have their public load path set as their page title. This groups the API docs more naturally by file. The path can be customized. * `sphinx_stardocs` can have a footer specified for generated pages. This allows easily added a list of link labels for easy re-use. * `readthedocs_install` now tries harder to find an open port * The conf.py file is moved into the generated sources directly. This was done because some config settings are relative to the conf.py file, which was being placed one directory above the regular sources. Fixes #1484, #1481
This repository is the home of the core Python rules -- py_library, py_binary, py_test, py_proto_library, and related symbols that provide the basis for Python support in Bazel. It also contains package installation rules for integrating with PyPI and other indices.
Documentation for rules_python is at https://rules-python.readthedocs.io and in the Bazel Build Encyclopedia.
Examples live in the examples directory.
Currently, the core rules build into the Bazel binary, and the symbols in this repository are simple aliases. However, we are migrating the rules to Starlark and removing them from the Bazel binary. Therefore, the future-proof way to depend on Python rules is via this repository. SeeMigrating from the Bundled Rules below.
The core rules are stable. Their implementation in Bazel is subject to Bazel's backward compatibility policy. Once migrated to rules_python, they may evolve at a different rate, but this repository will still follow semantic versioning.
The Bazel community maintains this repository. Neither Google nor the Bazel team provides support for the code. However, this repository is part of the test suite used to vet new Bazel releases. See How to contribute page for information on our development workflow.
For detailed documentation, see https://rules-python.readthedocs.io
See Bzlmod support for more details.