Skip to content

Update docs with new installation instructions #10

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
RastislavTuranyi merged 2 commits into from
Feb 19, 2025
Merged

Update docs with new installation instructions #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4faac47
Update README
Feb 19, 2025
80f5f9f
Update docs
Feb 19, 2025
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
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,19 @@ For more information, see the [documentation](https://pace-neutrons.github.io/in

## Installation

At the moment, the only way is to install manually via pip, either directly from GitHub:
Inline reference can be installed via pip:

```
pip install inline_reference
```

or manually from GitHub:

```
pip install git+https://github.com/pace-neutrons/inline_reference
```

or from a local copy:
or a local copy:

```
git clone https://github.com/pace-neutrons/inline_reference.git
Expand Down
11 changes: 9 additions & 2 deletions docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,15 @@ Installation
Pip
---

Currently, the only way to install the extension is by ``pip`` from GitHub. This can be done either
directly from GitHub::
The extension can be installed using pip::

pip install inline_reference


Manual installation
^^^^^^^^^^^^^^^^^^^

Alternatively, it can be installed manually, either from GitHub::

pip install git+https://github.com/pace-neutrons/inline_reference

Expand Down