You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -59,12 +59,12 @@ If you are new to Read the Docs, you may want to refer to the [Read the Docs Use
59
59
60
60
If you are copying this code in order to get started with your documentation, you need to:
61
61
62
-
- Create a new repository on Github, GitLab, Bitbucket or another host
63
-
supported by Read the Docs
64
-
- Customize all `docs/*.md` files and copy in `mkdocs.yaml`
65
-
- Add your own Python project, replacing the `pyproject.toml` configuration and `lumache.py` module.
66
-
- Rebuild the documenation locally to see that it works.
67
-
- Register your project on Read the Docs, see [Importing Your Documentation](https://docs.readthedocs.io/en/stable/intro/import-guide.html).
62
+
1. place your `docs/` folder alongside your Python project. If you are starting a new project, you can adapt the `pyproject.toml` example configuration.
63
+
1. use your existing project repository or create a new repository on Github, GitLab, Bitbucket or another host supported by Read the Docs.
64
+
1. copy in `mkdocs.yaml`, `.readthedocs.yml` and the `docs/` folder into your project. Customize all the files, replacing example contents.
65
+
1. Rebuild the documenation locally to see that it works.
66
+
1.*Finally*, register your project on Read the Docs, see [Importing Your Documentation](https://docs.readthedocs.io/en/stable/intro/import-guide.html).
0 commit comments