Skip to content
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
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ jobs:
pixi-version: v0.63.1

- name: Build documentation with Sphinx
run: pixi run sphinx-build -b html source build/html
run: pixi run -e sphinx-doc sphinx-html

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "build/html"
path: "build_docs"

deploy:
needs: build
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ instance/
.scrapy

# Sphinx documentation
docs/
build_docs/

# PyBuilder
.pybuilder/
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,19 +93,27 @@ pixi shell
# use development dependencies like jupyter notebooks/ipython
jupyterlab
```
#### Tests

### Tests
```bash
# Run tests
pixi run test
```

#### Linting
### Linting
```bash
# Linting
pixi run lint
pixi run format
```

### Documentation
```bash
# Build Sphinx documentation
pixi run -e sphinx-doc sphinx-html
# Output will be in build/html/index.html
```

## License

MIT License
5 changes: 0 additions & 5 deletions doc/css/code_select.css

This file was deleted.

12 changes: 0 additions & 12 deletions doc/doc_src/configuration.md

This file was deleted.

1 change: 0 additions & 1 deletion doc/doc_src/example_config/example_config.yml

This file was deleted.

100 changes: 0 additions & 100 deletions doc/doc_src/example_data/coffee_productivity.csv

This file was deleted.

5 changes: 0 additions & 5 deletions doc/doc_src/example_script.md

This file was deleted.

1 change: 0 additions & 1 deletion doc/doc_src/index.md

This file was deleted.

23 changes: 0 additions & 23 deletions doc/doc_src/installation.md

This file was deleted.

3 changes: 0 additions & 3 deletions doc/doc_src/license.md

This file was deleted.

73 changes: 0 additions & 73 deletions doc/doc_src/snippets/example_notebook.ipynb

This file was deleted.

60 changes: 0 additions & 60 deletions doc/doc_src/snippets/example_script.py

This file was deleted.

6 changes: 0 additions & 6 deletions doc/doc_src/usage.md

This file was deleted.

1 change: 0 additions & 1 deletion doc/images/documentation_logo.svg

This file was deleted.

Loading