Fix broken links in docs #1329
Fix broken links in docs #1329
Conversation
pentschev
added
3 - Ready for Review
docs/source/explicit_comms.rst
Outdated
| @@ -14,4 +14,4 @@ Usage | |||
| In order to use explicit-comms in Dask/Distributed automatically, simply define the environment variable ``DASK_EXPLICIT_COMMS=True`` or setting the ``"explicit-comms"`` | |||
| key in the `Dask configuration <https://docs.dask.org/en/latest/configuration.html>`_. | |||
|
|
|||
| It is also possible to use explicit-comms in tasks manually, see the `API <api.html#explicit-comms>`_ and our `implementation of shuffle <https://github.com/rapidsai/dask-cuda/blob/branch-0.20/dask_cuda/explicit_comms/dataframe/shuffle.py>`_ for guidance. | |||
| It is also possible to use explicit-comms in tasks manually, see the `API <api/#explicit-comms>`_ and our `implementation of shuffle <https://github.com/rapidsai/dask-cuda/blob/branch-24.06/dask_cuda/explicit_comms/dataframe/shuffle.py>`_ for guidance. | |||
There was a problem hiding this comment.
suggestion: Use main rather than nightly branch? (see comment above)
There was a problem hiding this comment.
I think we can leave this. However, one thing occurs to me. We now need to go through and update this branch link with every new release, yes?
There was a problem hiding this comment.
I think we can leave this. However, one thing occurs to me. We now need to go through and update this branch link with every new release, yes?
Yes, which is what this change does, this script is launched when a new branch is created.
Co-authored-by: Ray Douglass <[email protected]>
ci/release/update-version.sh
Outdated
| @@ -56,3 +56,8 @@ for FILE in .github/workflows/*.yaml; do | |||
| sed_runner "/shared-workflows/ s/@.*/@branch-${NEXT_SHORT_TAG}/g" "${FILE}" | |||
| done | |||
| sed_runner "s/RAPIDS_VERSION_NUMBER=\".*/RAPIDS_VERSION_NUMBER=\"${NEXT_SHORT_TAG}\"/g" ci/build_docs.sh | |||
|
|
|||
| # Docs referencing source code | |||
| for FILE in docs/source/*.rst; do | |||
There was a problem hiding this comment.
This will only list the .rst files directly in that directory, so docs/source/examples/ucx.rst for example isn't included (it doesn't need to be though).
This could be updated to use find instead: https://github.com/rapidsai/cuml/blob/branch-24.06/ci/release/update-version.sh#L82
There was a problem hiding this comment.
I think?
| for FILE in docs/source/*.rst; do | |
| find .docs/source/ -type f -name '*.rst' -print0 | while IFS= read -r -d '' FILE; do |
There was a problem hiding this comment.
I don't think it's necessary right now but it won't hurt either, so I applied that change in 19522fd . Thanks for linking that find line.
|
Thanks @wence- and @raydouglass for the reviews! |
|
/merge |
It was brought to our attention that some links in our docs are broken, this change should fix those issues.
Closes #1328