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
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).
Read the Docs Build configuration is stored in `.readthedocs.yaml`.
@@ -21,9 +15,7 @@ Read the Docs Build configuration is stored in `.readthedocs.yaml`.
21
15
A basic [MkDocs configuration](https://www.mkdocs.org/user-guide/configuration/) is stored here, including a few extensions for MkDocs and Markdown. Add your own configurations here, such as extensions and themes. Remember that many extensions and themes require additional Python packages to be installed.
22
16
23
17
📍 [docs/requirements.txt](https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/docs/requirements.txt) and [docs/requirements.in](https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/docs/requirements.in)<br>
(uses [pip-tools](https://pip-tools.readthedocs.io/en/latest/)) here. Make sure to add your Python dependencies to `requirements.txt` or if you choose [pip-tools](https://pip-tools.readthedocs.io/en/latest/), edit `docs/requirements.in` and remember to run to run `pip-compile docs/requirements.in`.
18
+
Python dependencies are [pinned](https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html) (uses [pip-tools](https://pip-tools.readthedocs.io/en/latest/)) here. Make sure to add your Python dependencies to `requirements.txt` or if you choose [pip-tools](https://pip-tools.readthedocs.io/en/latest/), edit `docs/requirements.in` and remember to run to run `pip-compile docs/requirements.in`.
We add our example Python module `lumache` in order to auto-generate an API reference. To do this, we use the `:::` syntax, you can read more in the [mkdocstrings documentation](https://mkdocstrings.github.io/).
@@ -39,10 +31,7 @@ We use a basic versioning mechanism by adding a git tag for every release of the
Contents of this `README.md` are visible on Github and included on [the documentation index page](https://example-mkdocs-basic.readthedocs.io/en/latest/) (Don\'t Repeat Yourself).
46
35
47
36
⁉️ Questions / comments<br>
48
37
If you have questions related to this example, feel free to can ask them as a Github issue [here](https://github.com/readthedocs-examples/example-mkdocs-basic/issues).
@@ -66,25 +55,18 @@ mkdocs serve
66
55
Using the example in your own project
67
56
-------------------------------------
68
57
69
-
If you are new to Read the Docs, you may want to refer to the [Read the
70
-
Docs User documentation](https://docs.readthedocs.io/).
58
+
If you are new to Read the Docs, you may want to refer to the [Read the Docs User documentation](https://docs.readthedocs.io/).
71
59
72
-
If you are copying this code in order to get started with your
73
-
documentation, you need to:
60
+
If you are copying this code in order to get started with your documentation, you need to:
74
61
75
62
- Create a new repository on Github, GitLab, Bitbucket or another host
76
63
supported by Read the Docs
77
64
- Customize all `docs/*.md` files and copy in `mkdocs.yaml`
78
-
- Add your own Python project, replacing the `pyproject.toml`
79
-
configuration and `lumache.py` module.
65
+
- Add your own Python project, replacing the `pyproject.toml` configuration and `lumache.py` module.
80
66
- Rebuild the documenation locally to see that it works.
81
-
- Register your project on Read the Docs, see [Importing Your
- Register your project on Read the Docs, see [Importing Your Documentation](https://docs.readthedocs.io/en/stable/intro/import-guide.html).
83
68
84
69
Read the Docs tutorial
85
70
----------------------
86
71
87
-
To get started with Read the Docs, you may also refer to the [Read the
88
-
Docs tutorial](https://docs.readthedocs.io/en/stable/tutorial/). It
89
-
provides a full walk-through of building an example project similar to
90
-
the one in this repository.
72
+
To get started with Read the Docs, you may also refer to the [Read the Docs tutorial](https://docs.readthedocs.io/en/stable/tutorial/). It provides a full walk-through of building an example project similar to the one in this repository.
0 commit comments