Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
2maz committed Mar 11, 2025
1 parent 3085365 commit baf3aad
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/damast)](https://pypi.org/project/damast/)
![test workflow](https://github.com/simula/damast/actions/workflows/test.yml/badge.svg)
![docs workflow](https://github.com/simula/damast/actions/workflows/gh-pages.yml/badge.svg)

# damast: Creation of reproducible data processing pipelines

Documentation at: https://simula.github.io/damast
Expand Down Expand Up @@ -53,19 +57,17 @@ To enter the container:

## Usage

Once you installed the package you can locally generate the documentation:
To get the usage documentation it is easiest to check the published documentation [here](https://simula.github.io/damast/README.html).

Otherwise, you can also locally generate the latest documentation once you installed the package:
```
tox -e build_docs
```
You can then open the documentation with a browser:
Then open the documentation with a browser:
```
<yourbrowser> _build/html/index.html
```

Otherwise you will find API and usage documentation [here](https://simula.github.io/damast/README.html).




## Testing

Expand Down

0 comments on commit baf3aad

Please sign in to comment.