Skip to content

Commit

Permalink
Capitalize PDM in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lioman committed Oct 29, 2023
1 parent 00d26fc commit eb052ca
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Setting up the development environment
======================================

While there are many ways to set up one's development environment, the following
instructions will utilize Pip_ and pdm_. These tools facilitate managing
instructions will utilize Pip_ and PDM_. These tools facilitate managing
virtual environments for separate Python projects that are isolated from one
another, so you can use different packages (and package versions) for each.

Please note that Python |min_python| is required for Pelican development.

*(Optional)* If you prefer to `install pdm <https://pdm.fming.dev/latest/#installation>`_ once for use with multiple projects,
*(Optional)* If you prefer to `install PDM <https://pdm.fming.dev/latest/#installation>`_ once for use with multiple projects,
you can install it via::

curl -sSL https://pdm.fming.dev/install-pdm.py | python3 -
Expand All @@ -35,7 +35,7 @@ as a Git remote::
cd ~/projects/pelican
git remote add upstream https://github.com/getpelican/pelican.git

While pdm can dynamically create and manage virtual environments, we're going
While PDM can dynamically create and manage virtual environments, we're going
to manually create and activate a virtual environment::

mkdir ~/virtualenvs && cd ~/virtualenvs
Expand All @@ -51,7 +51,7 @@ Install the needed dependencies and set up the project::
Your local environment should now be ready to go!

.. _Pip: https://pip.pypa.io/
.. _pdm: https://pdm.fming.dev/latest/
.. _PDM: https://pdm.fming.dev/latest/
.. _Pelican repository: https://github.com/getpelican/pelican

Development
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ dependencies = [
"rich>=10.1",
"unidecode>=1.1",
"backports-zoneinfo<1.0.0,>=0.2.1;python_version<'3.9'",
"watchfiles",
"watchfiles>=0.21.0",
]

[project.optional-dependencies]
Expand Down

0 comments on commit eb052ca

Please sign in to comment.