Skip to content

Commit

Permalink
fix mkdocs warnings (#304)
Browse files Browse the repository at this point in the history
This PR contains several minor miscellaneous changes.

The mkdocs warnings are:

```
WARNING -  mkdocs_autorefs: Multiple primary URLs found for 'gnps-data': ['quickstart/#gnps-data', 'concepts/gnps_data/#gnps-data']. Make sure to use unique headings, identifiers, or Markdown anchors (see our
           docs).
WARNING -  mkdocs_autorefs: concepts/bigscape.md: Could not find cross-reference target 'default-configurations'
```
  • Loading branch information
CunliangGeng authored Jan 24, 2025
1 parent fb5fa0b commit 9ad2d51
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 8 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ jobs:
python3 --version
- name: Upgrade pip and install dependencies
run: |
python3 -m pip install --upgrade pip setuptools
pip install build pytest wheel pytest-xdist
- name: Build the package
run: python -m build
Expand Down Expand Up @@ -79,7 +78,6 @@ jobs:
python3 --version
- name: Upgrade pip and install dependencies
run: |
python3 -m pip install --upgrade pip setuptools
pip install build pytest wheel pytest-xdist
- name: Build the package
run: python -m build
Expand Down
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ help:
@echo "update - update pip, build, twine packages"
@echo "update-version - update NPLinker version. Usage: make update-version CURRENT_VERSION=0.1.0 NEW_VERSION=0.2.0"

clean: clean-build clean-pyc clean-test
clean: clean-build clean-pyc clean-test clean-doc

clean-build:
rm -fr build/
Expand All @@ -30,6 +30,9 @@ clean-test:
rm -f .coverage*
rm -f coverage.xml

clean-doc:
rm -rf site

build: clean
python -m build
ls -l dist
Expand Down
4 changes: 1 addition & 3 deletions docs/concepts/bigscape.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
NPLinker can run BigScape automatically if the `bigscape` directory does not exist in the working directory.
Both version 1 and version 2 of BigScape are supported.

See the [configuration template][configuration-template] for how to set parameters for running BigScape.

See the [default configurations][default-configurations] for the default parameters used in NPLinker.
See the [configuration template][configuration-template] for how to set parameters for running BigScape.
2 changes: 1 addition & 1 deletion docs/concepts/gnps_data.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GNPS data
# GNPS

NPLinker requires GNPS molecular networking data as input. It currently accepts data from both GNPS1
(https://gnps.ucsd.edu) and GNPS2 (https://gnps2.org) workflows.
Expand Down
6 changes: 5 additions & 1 deletion src/nplinker/metabolomics/gnps/gnps_downloader.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ def __init__(
ValueError: If the given GNPS version is not valid.
Examples:
>>> GNPSDownloader("c22f44b14a3d450eb836d607cb9521bb", "~/downloads")
Download GNPS1 job
>>> GNPSDownloader("c22f44b14a3d450eb836d607cb9521bb", "~/downloads", "1")
Download GNPS2 job
>>> GNPSDownloader("2014f321d72542afb5216c932e0d5079", "~/downloads", "2")
"""
if gnps_version == "1":
gnps_format = gnps_format_from_gnps1_task_id(task_id)
Expand Down

0 comments on commit 9ad2d51

Please sign in to comment.