Add more information about developer tooling for docs contributions #46636
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
This PR expands the guidelines for contributing to docs by adding a section about
esbonio
, a language server for sphinx.Additionally,
docs.ipynb
has been converted todocs.md
after a discussion with @can-anyscale; there was never any python code being executed in this doc, so there's no reason to have the added complexity of it being a notebook. I also added.virtual_documents/
to the.gitignore
for those times when we do need to modify a notebook with jupyterlab.Related issue number
No issue, but addressed doc-infra need to improving documentation editing and providing a syntax assistant.
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.