mirror of
https://github.com/vale981/ray
synced 2025-03-06 10:31:39 -05:00
3dda4e1d46
By setting the [Sphinx `default_role`](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-default_role) to [`py:obj`](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-obj), we can concisely cross-reference other Python APIs (classes or functions) in API docstrings while still maintaining the editor/IDE/terminal readability of the docstrings. Before this PR, when referencing a class or a function, the relevant role specification is required: :class:`Dataset`, :meth:`Dataset.map`, :func:`.read_parquet`. After this PR, the raw cross reference will work in most cases: `Dataset`, `Dataset.map`, `read_parquet`. ## Checks - [x] I've run `scripts/format.sh` to lint the changes in this PR. - [x] I've included any doc changes needed for https://docs.ray.io/en/master/. - [x] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/ - Testing Strategy - [x] Unit tests - [ ] Release tests - [ ] This PR is not tested :( |
||
|---|---|---|
| .. | ||
| _includes | ||
| _static | ||
| _templates | ||
| cluster | ||
| data | ||
| images | ||
| ray-air | ||
| ray-contribute | ||
| ray-core | ||
| ray-more-libs | ||
| ray-observability | ||
| ray-overview | ||
| ray-references | ||
| rllib | ||
| serve | ||
| train | ||
| tune | ||
| workflows | ||
| _toc.yml | ||
| conf.py | ||
| custom_directives.py | ||
| index.md | ||
| preprocess_github_markdown.py | ||
| robots.txt | ||