Skip to content
Open
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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ quarto render docs

## Deploying documentation (automated)

![Build Status](https://github.com/UBC-MDS/group_16_tame_your_files.git/actions/workflows/publish-test-pypi.yml/badge.svg)
Live site: https://ubc-mds.github.io/group_16_tame_your_files/reference/tame_your_files.html

Documentation is built by GitHub Actions and published to the `gh-pages` branch.
To enable GitHub Pages:

Expand Down
7 changes: 2 additions & 5 deletions docs/_quarto.yml → _quarto.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
project:
type: website
output-dir: _site
output-dir: /docs
render:
- index.qmd
- reference/tame_your_files.qmd
Expand Down Expand Up @@ -33,16 +33,13 @@ format:
execute:
freeze: auto

python:
path: ../src

quartodoc:
style: pkgdown
package: tame_your_files
dir: reference
out_index: tame_your_files.qmd
parser: numpy
source_dir: ../src
source_dir: /src
options:
include_private: false
include_imports: true
2 changes: 0 additions & 2 deletions docs/.gitignore

This file was deleted.

Loading
Loading