From a00d1b938ed7df9a812f1bdc8eb0282904a27cb0 Mon Sep 17 00:00:00 2001 From: Laurent Sorber Date: Wed, 10 Sep 2025 09:36:18 +0000 Subject: [PATCH] docs: reposition MkDocs section in README --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f569118..e64a2e3 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,19 @@ cz bump git push origin main --tags ``` +### Build and publish your Python project's docs + +To build and serve your Python project's docs, run: + +```sh +poe docs --serve +``` + +If your project is on GitHub, your docs will be published automatically to GitHub Pages every time you update the default branch. You can view the docs by clicking on the ![Documentation](https://img.shields.io/static/v1?label=Documentation&message=View&color=blue&logo=readme&logoColor=white) badge in your project's README. + +> [!TIP] +> Make sure to [configure the source of your project's GitHub Pages as GitHub Actions in your project settings](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow) to allow the GitHub Actions workflow to publish your docs. + ## 🍪 Migrating from Cookiecutter > [!IMPORTANT] @@ -92,19 +105,6 @@ To migrate a project from Cookiecutter to Copier, follow these steps: 5. Create a PR from your branch, review it, and merge it! -### Build and publish your Python project's docs - -To build and serve your Python project's docs, run: - -```sh -poe docs --serve -``` - -If your project is on GitHub, your docs will be published automatically to GitHub Pages every time you update the default branch. You can view the docs by clicking on the ![Documentation](https://img.shields.io/static/v1?label=Documentation&message=View&color=blue&logo=readme&logoColor=white)] badge in your project's README. - -> [!TIP] -> Make sure to [configure the source of your project's GitHub Pages as GitHub Actions in your project settings](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow) to allow the GitHub Actions workflow to publish your docs. - ## Contributing