From 67ee32650dc92f57d9f028502935f6b5751a9bb4 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Fri, 8 Jul 2022 17:04:20 +0200 Subject: [PATCH 1/2] Fixes very first sentence --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c00111..27b9c93 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Example: Basic MkDocs project for Read the Docs [![Documentation Status](https://readthedocs.org/projects/example-mkdocs-basic/badge/?version=latest)](https://example-mkdocs-basic.readthedocs.io/en/latest/?badge=latest) -This example shows the an integration of a basic MkDocs project with Read the Docs. You\'re encouraged to view it to get inspiration and copy & paste from the files in the source code. If you are using Read the Docs for the first time, have a look at the official [Read the Docs Tutorial](https://docs.readthedocs.io/en/stable/tutorial/index.html). +This example shows a basic MkDocs project with Read the Docs. You're encouraged to view it to get inspiration and copy & paste from the files in the source code. If you are using Read the Docs for the first time, have a look at the official [Read the Docs Tutorial](https://docs.readthedocs.io/en/stable/tutorial/index.html). 📚 [docs/](https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/docs/)
A basic MkDocs project lives in `docs/`, it was generated using MkDocs defaults. All the `*.md` make up sections in the documentation. From d40c353ebf308f96de8722c126c294e69a98feed Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Fri, 8 Jul 2022 17:08:43 +0200 Subject: [PATCH 2/2] Fix a couple of more mistakes --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27b9c93..38a599a 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,8 @@ If you are copying this code in order to get started with your documentation, yo 1. place your `docs/` folder alongside your Python project. If you are starting a new project, you can adapt the `pyproject.toml` example configuration. 1. use your existing project repository or create a new repository on Github, GitLab, Bitbucket or another host supported by Read the Docs. -1. copy in `mkdocs.yaml`, `.readthedocs.yml` and the `docs/` folder into your project. Customize all the files, replacing example contents. +1. copy `mkdocs.yml`, `.readthedocs.yaml` and the `docs/` folder into your project. +1. customize all the files, replacing example contents. 1. Rebuild the documenation locally to see that it works. 1. *Finally*, register your project on Read the Docs, see [Importing Your Documentation](https://docs.readthedocs.io/en/stable/intro/import-guide.html).