DOC, MAINT: Centralize and expand development-related docs #2734
Conversation
This file contains hidden or 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
|
|
||
| .. hint:: If building the library in-place without installing, it's then necessary to set environment variable ``$PYTHONPATH`` to point to the root of the repository in order to ble able to import the modules in Python. | ||
|
|
||
| Build using conda |
There was a problem hiding this comment.
@Alexsandruss Please review this part thoroughly and feel free to modify if it's unclear or if it's missing something.
| Topics for Contributors | ||
| ======================= | ||
|
|
||
| Adding an estimator |
There was a problem hiding this comment.
@icfaust Please review this section in particular.
| else: | ||
| # code branch for sklearn<1.7 | ||
|
|
||
| Test helpers |
There was a problem hiding this comment.
@icfaust I might be missing something here so please review thoroughly.
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
| .. include:: substitutions.rst | ||
|
|
||
| ======================= | ||
| Topics for Contributors |
There was a problem hiding this comment.
@icfaust Feel free to add some instructions about what would be needed in order to add a patched function that is not an estimator class, like a kernel or similar.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Currently, documentation is spread throughout a mixture of .md and .rst files in different places. This PR centralizes all of the development-related docs into a single place, and updates links accordingly.
Along the way, it also adds more links and details about some topics that the current docs are missing.
IMPORTANT!! In order for this PR to work without breaking anything until a subsequent release, it will be required to have some kind of job uploading doc pages from the main branch - e.g. as a "development" version in the version switcher. This PR assumes that there will be a deployment available under that name, so it adds the currently non-existent links to it in the readme:
https://uxlfoundation.github.io/scikit-learn-intelex/development
Note however that the PR doesn't touch the file
SECURITY.md, since it appears to be a hard-coded name for the OSSF scorecard and for some github built-in features.Checklist:
Completeness and readability
Testing