Skip to content

Remove unnecessary $ symbols in documentation code blocks #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathan-hess merged 1 commit into from
Sep 16, 2023
Merged

Remove unnecessary $ symbols in documentation code blocks #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions docs/source/getting_started/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ install the latest package release is through pip:

.. code-block:: shell

$ pip install pyxx
pip install pyxx

.. tab-item:: Windows
:sync: windows

.. code-block:: powershell

C:\>pip install pyxx
pip install pyxx

As with any Python project, it may be useful to consider setting up a
`virtual environment <https://docs.python.org/3/library/venv.html>`__
Expand All @@ -49,14 +49,14 @@ you can install the package directly from the project's GitHub page using:

.. code-block:: shell

$ pip install git+https://github.com/nathan-hess/python-utilities.git@main
pip install git+https://github.com/nathan-hess/python-utilities.git@main

.. tab-item:: Windows
:sync: windows

.. code-block:: powershell

C:\>pip install git+https://github.com/nathan-hess/python-utilities.git@main
pip install git+https://github.com/nathan-hess/python-utilities.git@main


Source Code
Expand All @@ -81,17 +81,14 @@ First, clone the source repository to a location of your choice:

.. code-block:: shell

$ git clone https://github.com/nathan-hess/python-utilities.git
git clone https://github.com/nathan-hess/python-utilities.git

.. tab-item:: Windows
:sync: windows

.. code-block:: powershell

C:\>git clone https://github.com/nathan-hess/python-utilities.git

Note that it is not recommended that you download the source code to
your ``C:\`` directory; this is merely shown as a general example.
git clone https://github.com/nathan-hess/python-utilities.git

Then, add the root directory of the repository to your ``PYTHONPATH`` environment
variable:
Expand All @@ -103,14 +100,14 @@ variable:

.. code-block:: shell

$ export PYTHONPATH="$PYTHONPATH:$(pwd)/python-utilities"
export PYTHONPATH="$PYTHONPATH:$(pwd)/python-utilities"

.. tab-item:: Windows
:sync: windows

.. code-block:: powershell

C:\>set PYTHONPATH=%PYTHONPATH%;%CD%\python-utilities
set PYTHONPATH=%PYTHONPATH%;%CD%\python-utilities

Finally, make sure to install required dependencies through pip:

Expand All @@ -121,11 +118,11 @@ Finally, make sure to install required dependencies through pip:

.. code-block:: shell

$ pip install -r python-utilities/requirements.txt
pip install -r python-utilities/requirements.txt

.. tab-item:: Windows
:sync: windows

.. code-block:: powershell

C:\>pip install -r python-utilities\requirements.txt
pip install -r python-utilities\requirements.txt
2 changes: 1 addition & 1 deletion docs/source/usage/tutorials/unitconverters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Setup

.. code-block:: shell

$ pip install pyxx
pip install pyxx

For general information and CLI options, run:

Expand Down