Skip to content

Commit 9d1c0bc

Browse files
committed
docs: Remove requirements from README (not useful)
1 parent ca8d758 commit 9d1c0bc

1 file changed

Lines changed: 0 additions & 24 deletions

File tree

README.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -49,27 +49,3 @@ This works the same as [a normal link to that heading](../doc1.md#hello-world).
4949
Linking to a heading without needing to know the destination page can be useful if specifying that path is cumbersome, e.g. when the pages have deeply nested paths, are far apart, or are moved around frequently. And the issue is somewhat exacerbated by the fact that [MkDocs supports only *relative* links between pages](https://github.com/mkdocs/mkdocs/issues/1592).
5050

5151
Note that this plugin's behavior is undefined when trying to link to a heading title that appears several times throughout the site. Currently it arbitrarily chooses one of the pages.
52-
53-
## Requirements
54-
55-
mkdocs-autorefs requires Python 3.7 or above.
56-
57-
<details>
58-
<summary>To install Python 3.7, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>
59-
60-
```bash
61-
# install pyenv
62-
git clone https://github.com/pyenv/pyenv ~/.pyenv
63-
64-
# setup pyenv (you should also put these three lines in .bashrc or similar)
65-
export PATH="${HOME}/.pyenv/bin:${PATH}"
66-
export PYENV_ROOT="${HOME}/.pyenv"
67-
eval "$(pyenv init -)"
68-
69-
# install Python 3.7
70-
pyenv install 3.7.12
71-
72-
# make it available globally
73-
pyenv global system 3.7.12
74-
```
75-
</details>

0 commit comments

Comments
 (0)