Skip to content
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

remove redundancy of installing docs #76

Merged
merged 4 commits into from
Dec 21, 2023
Merged

remove redundancy of installing docs #76

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
559c31c
remove redundancy of installing docs
mirpedrol Dec 21, 2023
4da8301
Update docs/contributing/setup.md
mirpedrol Dec 21, 2023
58a160d
change version to 0.1.0 in the docs
mirpedrol Dec 21, 2023
0d71ffe
update compiling section from docs
mirpedrol Dec 21, 2023
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
40 changes: 13 additions & 27 deletions docs/contributing/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,6 @@ description: How to contribute to nf-co2footprint

# Getting started with plugin development

## Compiling

To compile and run the tests use the following command:

```bash
./gradlew check
```

## Launch without a local Nextflow build

The plugin can be tested prior release without using a local Nextflow build using the following steps:

1. Build the plugin:

```bash
make buildPlugins
```

2. Copy `build/plugins/nf-co2footprint-<version>` to `$HOME/.nextflow/plugins`
4. Run nextflow with this command:

```bash
nextflow run -plugins nf-co2footprint@0.4.0 <script/pipeline name> [pipeline params]
```

## Launch it with Nextflow

To test with Nextflow for development purpose:
Expand Down Expand Up @@ -59,7 +34,9 @@ To test with Nextflow for development purpose:
./launch.sh run -plugins nf-co2footprint <script/pipeline name> [pipeline params]
```

## Alternative: Compile and install to Nextflow plugins directory
## Alternative: Launch without a local Nextflow build

The plugin can be tested without using a local Nextflow build using the following steps:

!!! warning

Expand All @@ -76,10 +53,19 @@ To test with Nextflow for development purpose:
2. Run nextflow with this command, specifying the plugin version:

```bash
nextflow run -plugins nf-co2footprint@0.4.0 <script/pipeline name> [pipeline params]
nextflow run -plugins nf-co2footprint@0.1.0 <script/pipeline name> [pipeline params]
```


## Compiling and running tests

To compile and run the tests use the following command:

```bash
./gradlew check
```


## Change and preview the docs

The docs are generated using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). To change the docs, edit the files in the [docs/](docs/) folder and run the following command to generate the docs (after installing mkdocs via `pip install mkdocs-material`):
Expand Down
Loading