Skip to content

Commit

Permalink
[docs] Documentation workflow and basic docs
Browse files Browse the repository at this point in the history
See #15
  • Loading branch information
chrisbrickhouse committed Apr 9, 2024
1 parent 711f2a9 commit da2923d
Show file tree
Hide file tree
Showing 37 changed files with 9,380 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/quarto_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Build Docs

on:
push:
branches: ["main", "dev", "release-prep"]

jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install .
quartodoc build --config doc_src/_quarto.yml
- uses: quarto-dev/quarto-actions/setup@v2
- name: Render and publish to gh pages
uses: quarto-dev/quarto-actions/publish@v2
with:
target: gh-pages
path: doc_src
1 change: 1 addition & 0 deletions doc_src/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.quarto/
7 changes: 7 additions & 0 deletions doc_src/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
buildrender:
quartodoc build
quarto render

buildpreview:
quartodoc build
quarto preview
62 changes: 62 additions & 0 deletions doc_src/SnoopDogg_85SouthMedia.TextGrid
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
File type = "ooTextFile"
Object class = "TextGrid"

xmin = 0.0
xmax = 51.44
tiers? <exists>
size = 1
item []:
item [1]:
class = "IntervalTier"
name = "SPEAKER_00"
xmin = 0.0
xmax = 51.44
intervals: size = 12
intervals [1]:
xmin = 0.0
xmax = 6.24
text = " So you know the pimpin fuck y'all I'm gonna go over to dev jam"
intervals [2]:
xmin = 6.24
xmax = 8.78
text = " And learn a little bit of corporate work cuz I don't know corporate shit"
intervals [3]:
xmin = 8.78
xmax = 11.46
text = " I only need a few months right give me a few months around the shit"
intervals [4]:
xmin = 11.46
xmax = 18.94
text = " I'm a fast learner go to dev jam get a job in a position drop a record get Benny the butcher song get hip-hop Harry's on"
intervals [5]:
xmin = 18.94
xmax = 23.94
text = " Learn a few tricks of the trade find out that the niggas that had it that wanted me to hold for them"
intervals [6]:
xmin = 23.94
xmax = 26.12
text = " Then sold it to some other people"
intervals [7]:
xmin = 26.12
xmax = 29.9
text = " So now one of my big wig buddies called me and say hey dog"
intervals [8]:
xmin = 29.9
xmax = 34.38
text = " I know the people that got there from and they don't know what to do with it. Mmm"
intervals [9]:
xmin = 34.38
xmax = 40.72
text = " Let me hide them. I know just what to do with it. So I hit them like let me um, we work for y'all"
intervals [10]:
xmin = 40.72
xmax = 45.96
text = " The play was cool, but it's like yeah fuck that how much how much to buy this shit?"
intervals [11]:
xmin = 45.96
xmax = 50.22
text = " How much to buy death row first how much for my masters?"
intervals [12]:
xmin = 50.22
xmax = 51.44
text = " How much for all of the masters?"
65 changes: 65 additions & 0 deletions doc_src/_quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
project:
type: website
output-dir: _site

license: GPLv3

website:
favicon: assets/FAVE-logo.png
image: assets/FAVE-logo.png
page-navigation: true
navbar:
logo: assets/FAVE-logo.png
left:
- file: index.qmd
text: Get Started
- href: usage/
text: Examples
- href: reference/
text: Reference
right:
- icon: github
href: https://github.com/Forced-Alignment-and-Vowel-Extraction/fave-asr/
sidebar:
- id: get-started
title: Get Started
style: floating
align: left
contents:
- section: Getting Started
contents:
- index.qmd
- usage/index.qmd

format:
html:
theme:
light: flatly
dark: darkly
toc: true

# tell quarto to read the generated sidebar
metadata-files:
- reference/_sidebar.yml

interlinks:
sources:
python:
url: https://docs.python.org/3/

quartodoc:
# the name used to import the package you want to create reference docs for
package: fave_asr
style: pkgdown
dir: reference
# write sidebar data to this file
sidebar: "reference/_sidebar.yml"
parser: google
#render_interlinks: true
sections:
- title: FAVE ASR functions
#desc: |
# These functions comprise the main pipeline.
contents:
- package: fave_asr
name: fave_asr
Binary file added doc_src/_site/assets/FAVE-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit da2923d

Please sign in to comment.