Skip to content

Commit

Permalink
fix(doc): Remove gitpod stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
natir committed Apr 26, 2023
1 parent 4e9ee76 commit 8857c52
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 69 deletions.
13 changes: 11 additions & 2 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,16 @@ jobs:
run: pdm lock -v

- name: Install dependencies
run: pdm install -G duty -G docs -G quality -G typing -G security
run: pdm install -G duty -G docs -G tests

- name: Deploying documentation
- name: Run test
run: pdm run duty test

- name: Run coverage
run: pdm run duty coverage

- name: Build documentation
run: pdm run duty check-docs

- name: Deploy documentation
run: pdm run duty docs-deploy
7 changes: 0 additions & 7 deletions .gitpod.dockerfile

This file was deleted.

13 changes: 0 additions & 13 deletions .gitpod.yml

This file was deleted.

4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ check:

.PHONY: $(BASIC_DUTIES)
$(BASIC_DUTIES):
@$(DUTY) $@ $(call args,$@)
$(DUTY) $@ $(call args,$@)

.PHONY: $(QUALITY_DUTIES)
$(QUALITY_DUTIES):
@PDM_MULTIRUN_VERSIONS="3.9 3.10 3.11" pdm multirun duty $@ $(call args,$@)
PDM_MULTIRUN_VERSIONS="3.9 3.10 3.11" pdm multirun duty $@ $(call args,$@)
52 changes: 8 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# VariantPlanner

[![ci](https://github.com/natir/variantplanner/workflows/ci/badge.svg)](https://github.com/natir/variantplanner/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://natir.github.io/variantplanner/)
[![ci](https://github.com/natir/variantplanner/actions/workflows/ci.yml/badge.svg)](https://github.com/natir/variantplanner/actions/workflows/ci.yml)
[![doc](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://natir.github.io/variantplanner/)
[![pypi version](https://img.shields.io/pypi/v/variantplanner.svg)](https://pypi.org/project/variantplanner/)
[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/natir/variantplanner)
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/variantplanner/community)


A tool kit to manage many variant on desktop computer

## Installation

With `pip`:
```bash
pip install variantplanner
pip install git+https://github.com/natir/variantplanner.git#egg=variantplanner
```

With [`pipx`](https://github.com/pipxproject/pipx):
```bash
python3.8 -m pip install --user pipx
pipx install variantplanner
python -m pip install --user pipx
pipx install git+https://github.com/natir/variantplanner.git#egg=variantplanner
```

## Usage
Expand Down Expand Up @@ -102,41 +101,6 @@ variantplanner metadata -i metadata.json -o metadata.parquet json -f sample -f l
variantplanner metadata -i metadata.csv -o metadata.parquet csv -c sample -c link -c kindex
```

## Developement setup

Initialisation step:

```
git clone git@github.com:natir/VariantPlanner.git
cd VariantPlanner
pyenv install 3.9 3.10 3.11 # take care of solving build warning
make setup
```

Working step:

```
git switch -c <your_branch_name>
<write code>
make format # to auto-format the code
<write tests>
make test # to run the test suite
make check # to check if everything is OK
<commit your changes>
```

Please try to follow this commit message convention:
## Contribution

```
<type>(<scope>): <short summary>
│ │ │
│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end.
│ │
│ └─⫸ Commit Scope: io|format_conversion|data_manipulation|(other)
└─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test|(other)
```
All contributions are welcome, [see our "How to contribute" page.](https://natir.github.io/variantplanner/contributing/)
2 changes: 1 addition & 1 deletion duties.py
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ def docs_deploy(ctx: Context) -> None:
Parameters:
ctx: The context instance (passed automatically).
"""
ctx.run(mkdocs.gh_deploy, title="Deploying documentation")
ctx.run(mkdocs.gh_deploy(force=True), title="Deploying documentation")


@duty
Expand Down

0 comments on commit 8857c52

Please sign in to comment.