Skip to content

Commit

Permalink
docs: fix nanobind/pybind11 src & sp-dev (#429)
Browse files Browse the repository at this point in the history
Fixing #424.

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
  • Loading branch information
henryiii authored Jul 16, 2023
1 parent ed6b24d commit e543355
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ nox -s downstream -- https://github.com/...

# Setting up for development

See the [Scikit-HEP Developer introduction][skhep-dev-intro] for a detailed
description of best practices for developing packages.
See the [Scientific-Python Development Guide][skdev] for a detailed description
of best practices for developing packages.

[skhep-dev-intro]: https://scikit-hep.org/developer/intro
[skdev]: https://learn.scientific-python.org/development

## Quick development

Expand Down
11 changes: 7 additions & 4 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
If you've never made a Python package before,
[packaging.python.org's tutorial](https://packaging.python.org/en/latest/tutorials/packaging-projects/)
is a great place to start. It walks you through creating a simple package in
pure Python using modern tooling and configuration.
pure Python using modern tooling and configuration. Another great resource is
the
[Scientific Python Developer Guide](https://learn.scientific-python.org/development).

## Writing an extension

Expand Down Expand Up @@ -232,8 +234,9 @@ and wheel should never be in this list.
There are other keys you should include under `[project]` if you plan to publish
a package, but this is enough to start for now. The
[project metadata specification](https://packaging.python.org/en/latest/specifications/declaring-project-metadata)
page covers what keys are available. Another example is available at
[the Scientific Python Library Development Guide](https://scikit-hep.org/developer/pep621).
page covers what keys are available. Another example is available at [the
Scientific Python Library Development
Guide](https://learn.scientific-python.org/development/guides/.

### CMake file

Expand Down Expand Up @@ -265,7 +268,7 @@ to `pybind11::module`, your choice.

````{tab} nanobind
```{literalinclude} examples/getting_started/pybind11/CMakeLists.txt
```{literalinclude} examples/getting_started/nanobind/CMakeLists.txt
:language: cmake
```
Expand Down

0 comments on commit e543355

Please sign in to comment.