Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Pallas] [Docs] Replace full urls with label-based cross references #24091

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

copybara-service[bot]
Copy link

@copybara-service copybara-service bot commented Oct 3, 2024

[Pallas] [Docs] Replace full urls with label-based cross references

This PR uses the same method to add cross references as the previous PR #23889.


The content below is for future references.

Useful commands

Build documentation:

sphinx-build -b html -D nb_execution_mode=off docs docs/build/html -j auto

Create a label in *.md:

(pallas_block_specs_by_example)=

Create a label in *.rst:

.. _pallas_tpu_noteworthy_properties:

Reference a label in *.md:

{ref}`pallas_block_specs_by_example`

Sync changes from *.md to *.ipynb:

jupytext --sync docs/pallas/tpu/distributed.md

@copybara-service copybara-service bot changed the title [Pallas][Docs] Replace full urls with label-based cross references [Pallas] [Docs] Replace full urls with label-based cross references Oct 3, 2024
@copybara-service copybara-service bot force-pushed the test_681675621 branch 3 times, most recently from 1e9284d to e55c684 Compare October 3, 2024 21:24
This PR uses the same method to add cross references as the previous PR #23889.

---

The content below is for future references.

#### Useful commands

Build documentation:

```sh
sphinx-build -b html -D nb_execution_mode=off docs docs/build/html -j auto
```

Create a label in *.md:

```md
(pallas_block_specs_by_example)=
```

Create a label in *.rst:

```rst
.. _pallas_tpu_noteworthy_properties:
```

Reference a label in *.md:

```md
{ref}`pallas_block_specs_by_example`
```

Sync changes from *.md to *.ipynb:

```sh
jupytext --sync docs/pallas/tpu/distributed.md
```

PiperOrigin-RevId: 682034607
@copybara-service copybara-service bot merged commit e79d77a into main Oct 3, 2024
1 of 2 checks passed
@copybara-service copybara-service bot deleted the test_681675621 branch October 3, 2024 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant