Documentation: Updated installation and contribution documentation #4148
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
t20100
commented
Jul 9, 2024
| .. _their own CONTRIBUTING guide: https://github.com/scikit-image/scikit-image/blob/3736339272b9d129f98fc723b508ac5490c171fa/CONTRIBUTING.rst | ||
| .. _Issues page: https://github.com/silx-kit/silx/issues | ||
|
|
||
| Code formatting |
There was a problem hiding this comment.
Moved documentation from installation to contribution
Comment on lines
-80
to
-87
| :mod:`backends.BackendMatplotlib` | ||
| +++++++++++++++++++++++++++++++++ | ||
|
|
||
| .. currentmodule:: silx.gui.plot.backends.BackendMatplotlib | ||
|
|
||
| .. automodule:: silx.gui.plot.backends.BackendMatplotlib | ||
| :members: | ||
|
|
There was a problem hiding this comment.
This is causing warnings in the documentation build because matplotlib uses custom sphinx roles
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.
Checklist:
<Module or Topic>: <Action> <Summary>(see contributing guidelines)This PR reworks and moves/removes documentation regarding installation and contribution.
Some of the content was outdated or is better documented elsewhere (e.g., use of virtual environment: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments).
closes #4125