Skip to content

Commit 4b7f1e9

Browse files
committed
fidle with markdown for better formatting / readability after build
1 parent 5c7e334 commit 4b7f1e9

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

tutorials/publish-pypi.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -208,24 +208,19 @@ Example: `pyosPackage_yourNameHere`.
208208
:::{dropdown} Renaming your project before publishing
209209
:color: secondary
210210

211-
**Required**:
212-
0. Search your publishing location(s) to make sure your new name isn't taken
213-
- [TestPyPI](https://test.pypi.org/)
214-
- [PyPI](https://pypi.org/)
215-
- [conda-forge](https://conda-forge.org/packages/)
216-
1. Update the project name in your pyproject.toml file
217-
- `name = "pyospackage_yourNameHere"`
218-
2. Update the module folder name to be the same
219-
- `src/pyospackage_yourNameHere`
220-
3. Rebuild your project
221-
- `hatch build`
222-
4. Publish your package to capture the name (continue this guide!)
223-
224-
**Recommended**:
211+
#### Required
212+
213+
1. Search your publishing location(s) to make sure your new name isn't taken ([TestPyPI](https://test.pypi.org/), [PyPI](https://pypi.org/), [conda-forge](https://conda-forge.org/packages/))
214+
2. Update the project name in your pyproject.toml file (e.g. `name = "pyospackage_yourNameHere"`)
215+
3. Update the module folder name to be the same (e.g. `src/pyospackage_yourNameHere`)
216+
4. Rebuild your project (`hatch build`)
217+
5. Publish your package to capture the name (continue this tutorial!)
218+
219+
#### Recommended
220+
225221
- Update the Github repository name to align with the new package name
226-
- Update the project folder to match the new package name
227-
- `pyospackage_yourNameHere/src`
228-
- Update mentions of your repository name in other files; e.g. `README.md`
222+
- Update your local project folder to match the new package name (e.g. `pyospackage_yourNameHere/src`)
223+
- Update mentions of your repository name in other files (e.g. `README.md`)
229224
:::
230225

231226
:::{figure-md} test-pypi-search

0 commit comments

Comments
 (0)