weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity

Minor improvements to installation docs

Browse source
This commit is contained in:
Justin Mayer 2020-08-17 07:21:57 +02:00
commit af1c1773bb
1 changed files with 5 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/install.rst
View file

@ -3,8 +3,7 @@ Installing Pelican
Pelican currently runs best on 3.6+; earlier versions of Python are not supported. Pelican currently runs best on 3.6+; earlier versions of Python are not supported.
You can install Pelican via several different methods. The simplest is via You can install Pelican via several different methods. The simplest is via Pip_::
`pip <https://pip.pypa.io/en/stable/>`_::
python -m pip install pelican python -m pip install pelican
@ -12,7 +11,7 @@ Or, if you plan on using Markdown::
python -m pip install "pelican[markdown]" python -m pip install "pelican[markdown]"
(Keep in mind that operating systems will often require you to prefix the above (Keep in mind that some operating systems will require you to prefix the above
command with ``sudo`` in order to install Pelican system-wide.) command with ``sudo`` in order to install Pelican system-wide.)
While the above is the simplest method, the recommended approach is to create a While the above is the simplest method, the recommended approach is to create a
@ -47,10 +46,6 @@ markup format, you can install Pelican with Markdown support::
python -m pip install "pelican[markdown]" python -m pip install "pelican[markdown]"
Or you might need to install it a posteriori::
python -m pip install Markdown
Typographical enhancements can be enabled in your settings file, but first the Typographical enhancements can be enabled in your settings file, but first the
requisite `Typogrify <https://pypi.org/project/typogrify/>`_ library must be requisite `Typogrify <https://pypi.org/project/typogrify/>`_ library must be
installed:: installed::
@ -75,7 +70,7 @@ automatically installed without any action on your part:
* `unidecode <https://pypi.org/project/Unidecode/>`_, for ASCII * `unidecode <https://pypi.org/project/Unidecode/>`_, for ASCII
transliterations of Unicode text transliterations of Unicode text
utilities utilities
* `MarkupSafe <https://pypi.org/project/MarkupSafe/>`_, for a markup safe * `MarkupSafe <https://pypi.org/project/MarkupSafe/>`_, for a markup-safe
string implementation string implementation
* `python-dateutil <https://pypi.org/project/python-dateutil/>`_, to read * `python-dateutil <https://pypi.org/project/python-dateutil/>`_, to read
the date metadata the date metadata
@ -83,7 +78,7 @@ automatically installed without any action on your part:
Upgrading Upgrading
--------- ---------
If you installed a stable Pelican release via ``pip`` and wish to upgrade to If you installed a stable Pelican release via Pip_ and wish to upgrade to
the latest stable release, you can do so by adding ``--upgrade``:: the latest stable release, you can do so by adding ``--upgrade``::
python -m pip install --upgrade pelican python -m pip install --upgrade pelican
@ -124,4 +119,5 @@ content)::
The next step is to begin to adding content to the *content* folder that has The next step is to begin to adding content to the *content* folder that has
been created for you. been created for you.
.. _Pip: https://pip.pypa.io/
.. _virtualenv: https://virtualenv.pypa.io/en/latest/ .. _virtualenv: https://virtualenv.pypa.io/en/latest/