Fix links to documentation.
1. Links to the programming chapter were broken after 69c74f850e. They're now fixed with a redirect in readthedocs.io, but this commit updates them to the latest URL.
2. Most docs links should point to "stable" instead of "latest", since most users will want the docs for the released version, not the upcoming version. The exceptions are the programming chapter, and instructions for building the Python bindings from source.
PiperOrigin-RevId: 502821526
Change-Id: If0a55ab2be4751ba0165bf644030464234083133
This commit is contained in:
committed by
Copybara-Service
parent
6ba4d6f0de
commit
d7844aa5be
@@ -138,11 +138,11 @@ These packages give users of various languages access to MuJoCo functionality:
|
|||||||
|
|
||||||
#### First-party bindings
|
#### First-party bindings
|
||||||
|
|
||||||
- [Python bindings](https://mujoco.readthedocs.io/en/latest/python.html)
|
- [Python bindings](https://mujoco.readthedocs.io/en/stable/python.html)
|
||||||
- [dm_control](https://github.com/deepmind/dm_control), DeepMind's related
|
- [dm_control](https://github.com/deepmind/dm_control), DeepMind's related
|
||||||
environment stack, includes [PyMJCF](https://github.com/deepmind/dm_control/blob/main/dm_control/mjcf/README.md),
|
environment stack, includes [PyMJCF](https://github.com/deepmind/dm_control/blob/main/dm_control/mjcf/README.md),
|
||||||
a module for procedural manipulation of MuJoCo models.
|
a module for procedural manipulation of MuJoCo models.
|
||||||
- [C# bindings and Unity plug-in](https://mujoco.readthedocs.io/en/latest/unity.html)
|
- [C# bindings and Unity plug-in](https://mujoco.readthedocs.io/en/stable/unity.html)
|
||||||
|
|
||||||
#### Third-party bindings
|
#### Third-party bindings
|
||||||
|
|
||||||
@@ -193,8 +193,8 @@ copy of the License at https://www.apache.org/licenses/LICENSE-2.0.
|
|||||||
|
|
||||||
This is not an officially supported Google product.
|
This is not an officially supported Google product.
|
||||||
|
|
||||||
[build from source]: https://mujoco.readthedocs.io/en/latest/programming.html#building-mujoco-from-source
|
[build from source]: https://mujoco.readthedocs.io/en/latest/programming#building-mujoco-from-source
|
||||||
[Getting Started]: https://mujoco.readthedocs.io/en/latest/programming.html#getting-started
|
[Getting Started]: https://mujoco.readthedocs.io/en/latest/programming#getting-started
|
||||||
[acquisition]: https://www.deepmind.com/blog/opening-up-a-physics-simulator-for-robotics
|
[acquisition]: https://www.deepmind.com/blog/opening-up-a-physics-simulator-for-robotics
|
||||||
[open sourcing]: https://www.deepmind.com/blog/open-sourcing-mujoco
|
[open sourcing]: https://www.deepmind.com/blog/open-sourcing-mujoco
|
||||||
[Unity]: https://unity.com/
|
[Unity]: https://unity.com/
|
||||||
@@ -202,5 +202,5 @@ This is not an officially supported Google product.
|
|||||||
[GitHub Issues]: https://github.com/deepmind/mujoco/issues
|
[GitHub Issues]: https://github.com/deepmind/mujoco/issues
|
||||||
[documentation source files]: https://github.com/deepmind/mujoco/tree/main/doc
|
[documentation source files]: https://github.com/deepmind/mujoco/tree/main/doc
|
||||||
[mujoco.readthedocs.io]: https://mujoco.readthedocs.io
|
[mujoco.readthedocs.io]: https://mujoco.readthedocs.io
|
||||||
[Python Bindings]: https://mujoco.readthedocs.io/en/latest/python.html#python-bindings
|
[Python Bindings]: https://mujoco.readthedocs.io/en/stable/python.html#python-bindings
|
||||||
[PyPI]: https://pypi.org/project/mujoco/
|
[PyPI]: https://pypi.org/project/mujoco/
|
||||||
|
|||||||
+1
-1
@@ -32,7 +32,7 @@ the following principle is followed:
|
|||||||
If there is a contradiction between this guide and existing code, the guide
|
If there is a contradiction between this guide and existing code, the guide
|
||||||
takes precedence. Additional principles include:
|
takes precedence. Additional principles include:
|
||||||
|
|
||||||
- Follow the [naming conventions](https://mujoco.readthedocs.io/en/latest/programming.html#naming-convention).
|
- Follow the [naming conventions](https://mujoco.readthedocs.io/en/latest/programming#naming-convention).
|
||||||
- Be sparing with horizontal space: Try to keep lines short, avoid line-breaks
|
- Be sparing with horizontal space: Try to keep lines short, avoid line-breaks
|
||||||
where possble.
|
where possble.
|
||||||
- Be generous with vertical space: Empty lines between code blocks are good.
|
- Be generous with vertical space: Empty lines between code blocks are good.
|
||||||
|
|||||||
+1
-1
@@ -47,7 +47,7 @@ If you need to build the Python bindings from source, please consult
|
|||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Once installed, the package can be imported via `import mujoco`. Please consult
|
Once installed, the package can be imported via `import mujoco`. Please consult
|
||||||
our [documentation](https://mujoco.readthedocs.io/en/latest/python.html) for
|
our [documentation](https://mujoco.readthedocs.io/en/stable/python.html) for
|
||||||
further detail on the package's API.
|
further detail on the package's API.
|
||||||
|
|
||||||
We recommend going through the tutorial notebook which covers the basics of
|
We recommend going through the tutorial notebook which covers the basics of
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ class MuJoCoRenderTest(absltest.TestCase):
|
|||||||
"""Test that the bindings can successfully render a simple image.
|
"""Test that the bindings can successfully render a simple image.
|
||||||
|
|
||||||
This test sets up a basic MuJoCo rendering context similar to the example in
|
This test sets up a basic MuJoCo rendering context similar to the example in
|
||||||
https://mujoco.readthedocs.io/en/latest/programming.html#visualization
|
https://mujoco.readthedocs.io/en/latest/programming#visualization
|
||||||
It calls `mjr_rectangle` rather than `mjr_render` so that we can assert an
|
It calls `mjr_rectangle` rather than `mjr_render` so that we can assert an
|
||||||
exact rendered image without needing golden data. The purpose of this test
|
exact rendered image without needing golden data. The purpose of this test
|
||||||
is to ensure that the bindings can correctly return pixels in Python, rather
|
is to ensure that the bindings can correctly return pixels in Python, rather
|
||||||
|
|||||||
Reference in New Issue
Block a user