[Documentation] config options #1415
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@ZzEeKkAa are we still using the |
diptorupd
force-pushed
the
docs/config_options
branch
from
e211fb6 to
017b092
Compare
|
Documentation preview: show. |
ZzEeKkAa
approved these changes
Apr 1, 2024
|
Documentation preview removed. |
github-actions bot
added a commit
that referenced
this pull request
Apr 1, 2024
[Documentation] config options 5ff654f
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Python has no direct way of adding docstrings for global variables. To document all numba_dpex.config options on the documentation page, a rst file was being manually maintained. It resulted in the file not being updated much and being dated.
The PR updates the
config.pyto useannotationsto put the documentation into the config options. Not perfect, but better than manually updating the rst file.Fixes #683