docs: use kebab-case instead of snake_case for guide URLs #3942
Conversation
guide/src/building-and-distribution/multiple-python-versions.md
Outdated
Show resolved
Hide resolved
guide/pyclass_parameters.md
Outdated
| @@ -33,7 +33,7 @@ struct MyClass {} | |||
| struct MyClass {} | |||
| ``` | |||
|
|
|||
| [params-1]: https://docs.rs/pyo3/latest/pyo3/struct.PyAny.html | |||
| [params-1]: https://docs.rs/pyo3/latest/pyo3/types/struct.PyAny.html | |||
There was a problem hiding this comment.
Should this also use {{#PYO3_DOCS_URL}}?
There was a problem hiding this comment.
This one can't, purely because this fragment is also included in rustdoc for #[pyclass]. I did that for re-use but it was not the best idea maybe.
guide/src/getting-started.md
Outdated
| @@ -33,7 +33,7 @@ You can read more about `pyenv`'s configuration options [here](https://github.co | |||
|
|
|||
| ### Building | |||
|
|
|||
| There are a number of build and Python package management systems such as [`setuptools-rust`](https://github.com/PyO3/setuptools-rust) or [manually](https://pyo3.rs/latest/building_and_distribution.html#manual-builds). We recommend the use of `maturin`, which you can install [here](https://maturin.rs/installation.html). It is developed to work with PyO3 and provides the most "batteries included" experience, especially if you are aiming to publish to PyPI. `maturin` is just a Python package, so you can add it in the same you already install Python packages. | |||
| There are a number of build and Python package management systems such as [`setuptools-rust`](https://github.com/PyO3/setuptools-rust) or [manually](https://pyo3.rs/latest/building-and-distribution.html#manual-builds). We recommend the use of `maturin`, which you can install [here](https://maturin.rs/installation.html). It is developed to work with PyO3 and provides the most "batteries included" experience, especially if you are aiming to publish to PyPI. `maturin` is just a Python package, so you can add it in the same you already install Python packages. | |||
There was a problem hiding this comment.
Should this also use {{#PYO3_DOCS_URL}}?
There was a problem hiding this comment.
This should even just be a ./building-and-distribution.md relative link 👍
|
Thanks for catching all my egregious errors here! I will aim to fixup in the morning. |
Co-authored-by: Icxolu <[email protected]>
|
Ok, the benchmarks are broken for seemingly an unrelated reason, I think this is otherwise ready for a second look 😁 |
|
Thanks for the reviews! 👍 I'll have a few hours tomorrow to finish the docs while travelling, and I'll prep the beta release on top of those docs too (I don't think it matters if the docs for the beta don't get reviewed before pushing beta, I just would like there to be a general sense of Bound API and fewer GIL Refs in there 😁) |
Builds on #3941
We have a fair bit of inconsistency on the guide as to the URL structure. Some pages (like
async-await) use kebab case. The URL fragments for headings also use kebab case.A lot of pages were using snake case.
This PR moves those to kebab case and leaves some redirects from the old URLs for backwards compatibility.