forked from github/pelican
Add extra/optional Markdown dependency to setup.py
- Modify documentation to use the extra dependency in order to install the recommended markdown package version.
This commit is contained in:
parent
7aa2f6c142
commit
bc450b3339
3 changed files with 13 additions and 2 deletions
|
|
@ -9,6 +9,10 @@ You can install Pelican via several different methods. The simplest is via
|
||||||
|
|
||||||
pip install pelican
|
pip install pelican
|
||||||
|
|
||||||
|
Or, if you plan on using Markdown::
|
||||||
|
|
||||||
|
pip install pelican[Markdown]
|
||||||
|
|
||||||
(Keep in mind that operating systems will often require you to prefix the above
|
(Keep in mind that operating systems will often 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.)
|
||||||
|
|
||||||
|
|
@ -40,7 +44,11 @@ Optional packages
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
If you plan on using `Markdown <http://pypi.python.org/pypi/Markdown>`_ as a
|
If you plan on using `Markdown <http://pypi.python.org/pypi/Markdown>`_ as a
|
||||||
markup format, you'll need to install the Markdown library::
|
markup format, you can install Pelican with Markdown support::
|
||||||
|
|
||||||
|
pip install pelican[Markdown]
|
||||||
|
|
||||||
|
Or you might need to install it a posteriori::
|
||||||
|
|
||||||
pip install Markdown
|
pip install Markdown
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ Install Pelican (and optionally Markdown if you intend to use it) on Python
|
||||||
2.7.x or Python 3.5+ by running the following command in your preferred
|
2.7.x or Python 3.5+ by running the following command in your preferred
|
||||||
terminal, prefixing with ``sudo`` if permissions warrant::
|
terminal, prefixing with ``sudo`` if permissions warrant::
|
||||||
|
|
||||||
pip install pelican markdown
|
pip install pelican[Markdown]
|
||||||
|
|
||||||
Create a project
|
Create a project
|
||||||
----------------
|
----------------
|
||||||
|
|
|
||||||
3
setup.py
3
setup.py
|
|
@ -61,6 +61,9 @@ setup(
|
||||||
for name in names],
|
for name in names],
|
||||||
},
|
},
|
||||||
install_requires=requires,
|
install_requires=requires,
|
||||||
|
extras_require={
|
||||||
|
'Markdown': ['markdown~=3.1.1']
|
||||||
|
},
|
||||||
entry_points=entry_points,
|
entry_points=entry_points,
|
||||||
classifiers=[
|
classifiers=[
|
||||||
'Development Status :: 5 - Production/Stable',
|
'Development Status :: 5 - Production/Stable',
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue