Merge pull request #542 from JustinW80/docs-install-pre-releases

Document how to install pre-releases
doorstop-dev · Jan 25, 2022 · 0643d69 · 0643d69
2 parents d1d5a69 + 6e3b1e7
commit 0643d69
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
@@ -5,10 +5,19 @@ Doorstop requires [Python](https://www.python.org/) and [Git](https://git-scm.co
 Once Python is installed on your platform, install Doorstop using pip.
 
 ```sh
-pip install doorstop
+$ pip install doorstop
 ```
 
-or add it to your [Poetry](https://python-poetry.org/) project:
+!!! note "Installing Pre-releases"
+    By default, pip only installs stable [releases of Doorstop from PyPi](https://pypi.org/project/doorstop/#history).
+
+    To tell pip to install a pre-release version, [use the `--pre` option](https://pip.pypa.io/en/stable/cli/pip_install/#pre-release-versions):
+
+    ```
+    $ pip install --pre doorstop
+    ```
+
+Alternatively, add it to your [Poetry](https://python-poetry.org/) project:
 
 ```sh
 $ poetry add doorstop

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,6 +9,9 @@ theme: readthedocs
 extra_css: []
 extra_javascript: []
 
+markdown_extensions:
+  - admonition
+
 nav:
 - Home: index.md
 - Getting Started: