-
Notifications
You must be signed in to change notification settings - Fork 0
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
[Doc] Upgrade build tooling #2
[Doc] Upgrade build tooling #2
Conversation
86a6166
to
d2b0a4a
Compare
d2b0a4a
to
1129b29
Compare
1129b29
to
e4aff8b
Compare
Signed-off-by: pdmurray <peynmurray@gmail.com>
e4aff8b
to
8c1979d
Compare
https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events | ||
""" | ||
if pagename == "train/train": | ||
app.add_css_file("css/ray-train.css") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great, we really needed that clean-up.
Can be done later, but can we move the parse_navbar_config
etc. to e.g. custom_directives.py
or so? conf.py
is the one file most of our devs have to have a look at occasionally, and I don't want to blow it up too much.
Yep, good idea. I'll make a checklist for this kind of cleanup in the target branch for this PR, and do this before we merge ray-project#41115. |
Why are these changes needed?
This PR implements build tooling changes needed for the doc build system upgrade.
-W
: Turn warnings into errors during the build-j auto
: Enable parallel builds, significantly improving the time it takes to build the docsrequirements-doc.txt
sphinx-version-warning
- we weren't using it, it's unmaintained, and the JS was throwing errors upon page loadsphinx-tabs
, becausepydata-sphinx-theme
usessphinx-design
, which has a tab widget already. Having two tab widgets is a recipe for conflicting styles; additionally,sphinx-tabs
has a bug where thejs
assets for tabs are injected on every page even if no tabs are being used on that page; seesphinx-tabs
assets are not removed from pages wheretabs
aren't being used executablebooks/sphinx-tabs#184sphinx-external-toc
as it is incompatible with the latest versions ofsphinx
. It's not needed here, and has not seen much development in the past year._toc.yml
is removed as a result of this.pydata-sphinx-theme
, which is the theme on whichsphinx-book-theme
is based. It's currently actively maintained, and has seen recent releases with big improvements to accessibility. It also comes with a lot of what we want right out of the box, and using it removes a dependency from our docs build system. I think I've talked this decision at length now to multiple people, but if there are still any questions about this choice I'm happy to discuss further.Related issue number
Partially addresses ray-project#37944.
PR 1/x targeting ray-project#41115.
Tests may not pass here because some css and js assets and templates will be committed in a separate PR.
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.