David Matos
2ad2a3f208
docs: Make contributing.md slightly more clear for newer contributors ( #4080 )
...
* docs: Make contributing.md slightly more clear for newer contributors
* Remove accidental backticks
Rearrange overview of commands
* Placed on wrong line
* Add extra overview command
2024-04-16 08:17:41 +00:00
Liam
9a6b1962d3
Minor: Fix a typo in Contributing.md ( #4066 )
2024-04-11 21:11:51 +00:00
David Hewitt
9808f7111c
ci: add update-ui-tests
nox session ( #3979 )
...
* ci: add `update-ui-tests` nox session
* defer error messages after the group closes
* fix syntax warnings
2024-03-22 22:43:08 +00:00
David Hewitt
14d1d2a9ee
docs: use lychee
to check link URLs ( #3941 )
...
* guide: install `mdbook-linkcheck`
* use `shutil` to copy license files
* move from `mdbook-linkcheck` to `lychee`
* clean guide & doc build products before build
* fix more broken links
* review: mejrs
2024-03-08 14:10:47 +00:00
David Hewitt
a582fa0163
docs: update discord invite to permanent one ( #3913 )
2024-02-28 20:51:40 +00:00
David Hewitt
8f1b99e1e9
move chat discussions to Discord ( #3892 )
...
* move chat discussions to Discord
* guide: add some more signposting to the PyO3 Discord
2024-02-24 22:35:01 +00:00
Alexander Hill
0f92b670b2
docs: Add lcov / codecov options for nox coverage and update docs ( #3825 )
...
* docs: Clarify use of llmv-cov plugin
* Mention first-run
* Update Contributing.md
* Add options
* fix
2024-02-23 06:49:44 +00:00
alm
c24478e8bc
docs: fix link in Contributing.md ( #3845 )
2024-02-16 16:53:25 +00:00
Juha-Matti Santala
559761b2f1
docs: Clarify the requirement to install nox
...
Installing nox was mentioned in a later section when building
the user guide but not at this point earlier in the guide where
nox was needed for the first time.
2024-02-10 16:20:37 +02:00
David Hewitt
668918f5d3
skip changelog check for docs-only PRs
2023-09-21 21:43:48 +01:00
David Hewitt
c2e8ba3c14
move benches to subdirectory
2023-07-30 07:36:47 +01:00
David Hewitt
233fdd555e
add some style guide to Contributing.md
2023-07-04 21:03:24 +01:00
Adam Reichold
b816d4d561
Drop the xtask helper as it is superseded by Nox.
...
While the xtask code base is better engineered than our slightly messy Nox
manifest, all functionality is available via Nox including some that is not
available via xtask. Finally, only the Nox sessions are used in the CI by now so
that xtask does not see regular automated usage.
2023-06-05 17:41:41 +02:00
David Hewitt
bb99c98ec1
use towncrier to generate CHANGELOG
2022-09-08 07:58:53 +01:00
David Hewitt
b70318fd1b
guide: deployment to netlify
2022-08-19 12:46:56 +01:00
Nathan Henrie
1b7a850fad
Minor typo: missing space ( #2533 )
...
* Add missing space
* It's -> its
2022-08-04 22:45:05 +00:00
Bruno Kolenbrander
cbdd2e3b5c
xtask: expand on coverage ( #2449 )
...
* Install nightly if it is not installed
* Expand on coverage
* Don't swallow stdout
* Apply suggestions from code review
Co-authored-by: mejrs <>
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2022-06-14 07:28:25 +00:00
David Hewitt
9dfeaa38d4
guide: add contributing page ( #2442 )
...
Co-authored-by: messense <messense@icloud.com>
2022-06-08 13:30:11 +00:00
David Hewitt
15b164d45c
readme: add messense sponsor link
2022-06-08 06:47:12 +01:00
Bruno Kolenbrander
16ad15e04f
Expand on xtask ( #2176 )
...
* Fix Windows OSError
* Ignore .pyd files
* Put things in modules
* Rename functions to `run`
* Expand on cargo xtask
* Try to work around missing installs
* Run all things by default, but not llvm-cov
* Test msrv
* Fix more OSErrors
* Various refinements and docs
* Various refinements
* Various refinements
2022-03-18 22:13:23 +00:00
David Hewitt
8b47f4f120
pytests: merge benchmark and test crates
2022-02-05 10:16:46 +00:00
Aviram Hassan
47993e1e81
Add setting up a dev environment notes
2022-01-03 10:00:39 +02:00
mejrs
eccdcf7adb
fix link
2021-12-22 12:31:14 +01:00
mejrs
6afd80a26f
Create full feature and change doc rendering
2021-12-22 12:09:16 +01:00
David Hewitt
d59ef542b2
contributing: add command for docs build
2021-10-27 23:21:08 +01:00
David Hewitt
031d7bd094
makefile: fix test_py job, add list_all_additive_features
2021-10-24 08:03:55 +01:00
Alex Touchet
2a09583b28
Update various links and formatting
2021-09-18 11:48:45 -07:00
Eric Arellano
9ab7b1fad1
Rewrite module.md
for clarity and add tip on code organization ( #1693 )
...
* Rewrite `module.md` for clarity and add tip on code organization
* Add section on how to build the guide + add workaround proposed by David
* Make more clear references to #1709
2021-07-22 08:10:32 +01:00
David Hewitt
8416433623
docs: implement final missing safety docs
2021-06-24 07:19:49 +01:00
Yung-Jin (Joey) Hu
edb3d0d03b
Fix typos in Architecture and Contributing docs
2021-05-16 19:49:23 -07:00
David Hewitt
303f23389b
readme/contributing: sponsorship notes and minor tweaks
2021-04-03 09:39:50 +01:00
kngwyu
78c41831f3
[Architecture] Cover more topics and mention in Contributing
2021-03-13 16:39:16 +09:00
David Hewitt
cd7a27b34f
contributing: update minimum supported Rust policy
...
Co-authored-by: Georg Brandl <georg@python.org>
Co-authored-by: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com>
2021-02-18 07:57:21 +00:00
David Hewitt
51d1996218
ci: deny warnings using RUSTFLAGS
2020-12-26 08:27:08 +00:00
David Hewitt
bac1771de8
Update Python versions on CI
2020-10-10 10:40:21 +01:00
David Hewitt
06b15862dc
contributing.md: add note on benchmarking
2020-10-10 06:08:44 +01:00
David Hewitt
51111dc861
Migrate from Travis CI to Github Actions
2020-08-12 08:09:30 +01:00
David Hewitt
7e4995f860
Simplify language in Contributing.md
2020-08-08 23:41:31 +01:00
David Hewitt
9c212035ef
Make contributing notes much more helpful
2020-08-06 18:39:32 +01:00
Alexander Niederbühl
e59f973ba2
Fixup for Contributing.md
2019-04-23 22:14:27 +02:00
Alexander Niederbühl
f1b0288d3c
Remove docmatic and several workarounds for the doctests
2019-04-19 22:47:21 +02:00
Georg Brandl
3dc4af0522
Add advice for test and test-doc to Contributing.md
2019-04-18 08:09:42 +02:00
konstin
62d9b40274
Add Contributing.md
2019-02-10 19:42:24 +01:00