Skip to content

Commit 8e6bd6a

Browse files
committed
Remove auto-generated line-wraps, we can add semantic wraps later
1 parent f74b76e commit 8e6bd6a

File tree

1 file changed

+9
-27
lines changed

1 file changed

+9
-27
lines changed

README.md

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,10 @@ Example: Basic MkDocs project for Read the Docs
33

44
[![Documentation Status](https://readthedocs.org/projects/example-mkdocs-basic/badge/?version=latest)](https://example-mkdocs-basic.readthedocs.io/en/latest/?badge=latest)
55

6-
This example shows the an integration of a basic MkDocs project with
7-
Read the Docs. You\'re encouraged to view it to get inspiration and copy
8-
& paste from the files in the source code. If you are using Read the
9-
Docs for the first time, have a look at the official [Read the Docs
10-
Tutorial](https://docs.readthedocs.io/en/stable/tutorial/index.html).
6+
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).
117

128
📚 [docs/](https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/docs/)<br>
13-
A basic MkDocs project lives in `docs/`, it was generated using
14-
MkDocs defaults. All the `*.md` make up sections in the
15-
documentation.
9+
A basic MkDocs project lives in `docs/`, it was generated using MkDocs defaults. All the `*.md` make up sections in the documentation.
1610

1711
⚙️ [.readthedocs.yaml](https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/.readthedocs.yaml)<br>
1812
Read the Docs Build configuration is stored in `.readthedocs.yaml`.
@@ -21,9 +15,7 @@ Read the Docs Build configuration is stored in `.readthedocs.yaml`.
2115
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.
2216

2317
📍 [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>
24-
Python dependencies are
25-
[pinned](https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html)
26-
(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`.
2719

2820
💡 [docs/api.md](https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/docs/api.md)<br>
2921
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
3931
[example-mkdocs-basic.readthedocs.io](https://example-mkdocs-basic.readthedocs.io/en/latest/).
4032

4133
📜 [README.rst](https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/README.rst)<br>
42-
Contents of this `README.md` are visible on Github and included on
43-
[the documentation index
44-
page](https://example-mkdocs-basic.readthedocs.io/en/latest/)
45-
(Don\'t Repeat Yourself).
34+
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).
4635

4736
⁉️ Questions / comments<br>
4837
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
6655
Using the example in your own project
6756
-------------------------------------
6857

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/).
7159

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:
7461

7562
- Create a new repository on Github, GitLab, Bitbucket or another host
7663
supported by Read the Docs
7764
- 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.
8066
- Rebuild the documenation locally to see that it works.
81-
- Register your project on Read the Docs, see [Importing Your
82-
Documentation](https://docs.readthedocs.io/en/stable/intro/import-guide.html).
67+
- Register your project on Read the Docs, see [Importing Your Documentation](https://docs.readthedocs.io/en/stable/intro/import-guide.html).
8368

8469
Read the Docs tutorial
8570
----------------------
8671

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

Comments
 (0)