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.

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

Template: add option to exclude documentation from pipeline template #3130

Merged
merged 3 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
- add option to exclude license from pipeline template ([#3125](https://github.com/nf-core/tools/pull/3125))
- add option to exclude email from pipeline template ([#3126](https://github.com/nf-core/tools/pull/3126))
- add option to exclude fastqc from pipeline template ([#3129](https://github.com/nf-core/tools/pull/3129))
- add option to exclude documentation from pipeline template ([#3130](https://github.com/nf-core/tools/pull/3130))

### Linting

Expand Down
20 changes: 20 additions & 0 deletions nf_core/pipelines/create/templatefeatures.yml
Original file line number Diff line number Diff line change
Expand Up @@ -310,3 +310,23 @@ slackreport:
- ".prettierignore"
nfcore_pipelines: False
custom_pipelines: True
documentation:
skippable_paths:
- "docs"
short_description: "Add documentation"
description: "Add documentation to the pipeline"
help_text: |
This will add documentation markdown files where you can describe your pipeline.
It includes:
- docs/README.md: A README file where you can describe the structure of your documentation.
- docs/output.md: A file where you can explain the output generated by the pipeline
- docs/usage.md: A file where you can explain the usage of the pipeline and its parameters.

These files come with an exemplary documentation structure written.
linting:
files_exist:
- "docs/output.md"
- "docs/README.md"
- "docs/usage.md"
nfcore_pipelines: False
custom_pipelines: True
512 changes: 256 additions & 256 deletions tests/pipelines/__snapshots__/test_create_app.ambr

Large diffs are not rendered by default.

Loading