Skip to content

Commit

Permalink
Docs: Fix type, extend local install instructions, add `annotate-spec…
Browse files Browse the repository at this point in the history
…tra` usage mode.
  • Loading branch information
RalfG committed Jan 24, 2024
1 parent 17c7d21 commit 3a1be56
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
8 changes: 8 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,11 @@ Clone this repository and use pip to install an editable version:
.. code-block:: bash
pip install --editable .
Optionally, add the ``[dev,docs]`` extras to install the development and
documentation dependencies:

.. code-block:: bash
pip install --editable .[dev,docs]
2 changes: 1 addition & 1 deletion docs/source/prediction-models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Training new MS²PIP models
[todo]


Prediciton features
Prediction features
-------------------

The table below lists and describes all features generated and used by MS²PIP. These are mostly
Expand Down
5 changes: 5 additions & 0 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ This mode was first developed in collaboration with the ProGenTomics group for t

To train a new prediction model, see :ref:`Training new MS²PIP models`.

``annotate-spectra``
---------------------

[todo]


Input
=====
Expand Down

0 comments on commit 3a1be56

Please sign in to comment.