525b4b236a
Datalab docs improvements ( #714 )
2023-05-12 11:12:44 -07:00
cf5d2a02eb
Added installation instructions for package extras ( #697 )
...
Co-authored-by: Elías Snorrason <eliassno@gmail.com >
Co-authored-by: huiwengoh <45724323+huiwengoh@users.noreply.github.com >
2023-05-09 15:19:24 -04:00
49559ef619
Add dev note about linking functions ( #704 )
...
Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com >
2023-05-08 17:39:53 -07:00
79cc3eb601
DOC: use default rules for shorter, more readable links ( #700 )
...
Co-authored-by: Hui Wen <45724323+huiwengoh@users.noreply.github.com >
2023-05-04 23:51:38 -04:00
64edc95630
Introduce Datalab ( #614 )
...
Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com >
Co-authored-by: Jesse Cummings <jecummin@mit.edu >
Co-authored-by: Jesse Cummings <jecummin@users.noreply.github.com >
Co-authored-by: Hui Wen <45724323+huiwengoh@users.noreply.github.com >
2023-04-25 09:26:43 -07:00
497947a867
Fix tutorial hyperlinks in docs ( #642 )
2023-02-28 09:15:19 -08:00
2adb8b68b0
Removed $ from shell commands to avoid it being copied ( #625 )
2023-02-12 19:46:45 -08:00
0d9fee88a9
add maximum line length ( #583 )
...
and clarify where black settings are found in DEVELOPMENT guide
Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com >
2023-01-04 17:31:16 -08:00
9ec3a74d85
clarify not to use basic mypy without the CI flags
2022-12-28 14:18:33 -08:00
b6ce88d484
clarify mypy flags
2022-11-08 01:53:38 -08:00
c14c84fc49
note about M1 chip requirements
2022-10-05 21:27:53 -07:00
3690d5eed4
fix remaining docs/source links
2022-10-05 17:59:56 -07:00
1f72fd0bc3
fix links that dont work from some branches
2022-10-05 17:52:52 -07:00
8a567176ad
Update DEVELOPMENT.md with howto add new modules ( #494 )
...
Co-authored-by: Elías Snorrason <eliassno@gmail.com >
Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com >
2022-10-03 10:24:07 -07:00
43a795cb0c
Update DEVELOPMENT.md with Relative Linking ( #425 )
...
* Update DEVELOPMENT.md with Relative Linking
Added instructions for relative linking between docs and tutorials
* more link instructions
Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com >
2022-09-09 15:43:11 -07:00
1a239922fe
update link to docs/tutorials tips
2022-09-06 00:39:29 -07:00
d5d420f3cd
pep-8 pointer
2022-09-02 18:57:47 -07:00
0b4e9089d5
avoid import *
2022-08-31 22:22:36 -07:00
cccc8f8932
Fix capitalization in DEVELOPMENT.md ( #340 )
2022-08-16 14:30:25 -07:00
9abbb26bba
Added mypy instructions to DEVELOPMENT.md guide ( #339 )
...
* Added mypy and black instructions
* Fixed typo
* Fixed capetalization
* Resolved PR comments
2022-08-15 23:01:36 -07:00
31545f1e5c
More guidelines added to docs readme ( #321 )
...
* point to tutorial guidelines
* things not to forget for new tutorials
* docstring editing guidelines
2022-07-23 15:49:29 -07:00
29026b48f9
Add common variable names.
2022-06-20 11:53:24 -07:00
a782649680
development instructions for running all examples/ notebooks ( #174 )
...
* dev instructions for running all examples/ notebooks
* example local version specification
* missing period
2022-05-10 18:20:17 -07:00
dc6fa956cb
Make a pass over docs
2022-04-11 13:15:43 -04:00
e681521ac0
Add note on multiple types
2022-04-09 09:32:51 -04:00
90d6e77ed9
Revise filter
2022-04-09 07:33:24 -04:00
e086fdee74
Standardize how to format names
...
This follows NumPy style for reST documentation (but not for
Jupyter/Markdown).
2022-04-09 07:33:24 -04:00
acd3d040a5
Revise image tutorial
2022-04-09 07:33:24 -04:00
d91597e282
Revise pred_probs_cross_val
2022-04-09 07:33:24 -04:00
d93f9f3337
Revise quickstart
2022-04-09 07:33:24 -04:00
bf8e82d4bf
Add support for LaTeX math in documentation
2022-04-09 07:33:24 -04:00
9aef6c73a2
Document documentation standard
2022-04-09 07:33:23 -04:00
263d81c664
Add note on EditorConfig to development guide ( #176 )
2022-04-06 12:20:09 -07:00
9101b85e68
Add development guide
...
This patch also adds a pre-commit hook that runs Black.
2022-04-03 19:31:05 -04:00
Hui Wen