Doc refactor (#352)

Update docs for latest version

.github/workflows/main.yml

@@ -34,26 +34,3 @@ jobs:
         with:
           file: ./coverage.xml
           fail_ci_if_error: true
-      - name: Build a binary wheel and a source tarball
-        run: >-
-          python -m
-          build
-          --sdist
-          --wheel
-          --outdir dist/
-          .
-      - name: "List result"
-        run: "ls -l dist"
-      - name: "Check long_description"
-        run: "python -m twine check dist/*"
-      - name: Publish distribution 📦 to PyPI
-        if: startsWith(github.ref, 'refs/tags')
-        uses: pypa/gh-action-pypi-publish@master
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}
-      - name: Publish distribution 📦 to Test PyPI
-        continue-on-error: true
-        uses: pypa/gh-action-pypi-publish@master
-        with:
-          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
-          repository_url: https://test.pypi.org/legacy/

.github/workflows/publish.yml

@@ -0,0 +1,70 @@
+name: Publish Python distributions to PyPI and TestPyPI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build-n-publish:
+    name: Build and publish to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        # Adding -l {0} helps ensure conda can be found properly.
+        shell: bash -l {0}
+    env:
+      ENV_NAME: mfa_publish
+      PYTHON: 3.8
+    steps:
+      - uses: actions/checkout@main
+        with:
+          fetch-depth: 0
+
+      - name: Setup Miniconda
+        uses: conda-incubator/[email protected]
+        with:
+          auto-update-conda: true
+          miniconda-version: "latest"
+          python-version: ${{ env.PYTHON }}
+          environment-file: ci/${{ env.ENV_NAME }}.yml
+          activate-environment: ${{ env.ENV_NAME }}
+
+      - name: Conda Info
+        run: |
+          conda info -a
+          conda list
+          PYVER=`python -c "import sys; print('{:d}.{:d}'.format(sys.version_info.major, sys.version_info.minor))"`
+          if [[ $PYVER != ${{ env.PYTHON }} ]]; then
+            exit 1;
+          fi
+      - name: Create environment variable
+        if: startsWith(github.ref, 'refs/tags/') != true
+        run: |
+          wget https://gist.github.com/plaplant/0902f09e59166bac742bbd554f3cd2f9/raw/make_dev_version.sh
+          version=$(bash make_dev_version.sh)
+          echo "SETUPTOOLS_SCM_PRETEND_VERSION=$version" >> $GITHUB_ENV
+      - name: Check environment variable
+        run: echo $SETUPTOOLS_SCM_PRETEND_VERSION
+
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+      - name: Publish to Test PyPI
+        if: startsWith(github.event.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/
+
+      - name: Publish to PyPI
+        if: startsWith(github.event.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -21,6 +21,7 @@ pretrained_models/
 
 # Distribution / packaging
 montreal_forced_aligner/version.py
+montreal_forced_aligner/_version.py
 .Python
 env/
 build/
@@ -81,3 +82,6 @@ target/
 docs/source/api/
 
 montreal_forced_aligner/_version.py
+/docs/source/reference/generated/
+
+docs/source/reference/multiprocessing/generated/

ci/mfa_publish.yml

@@ -0,0 +1,24 @@
+name: mfa_publish
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - numpy
+  - librosa
+  - tqdm
+  - requests
+  - colorama
+  - pyyaml
+  - kaldi
+  - sox
+  - openfst
+  - baumwelch
+  - ngram
+  - pynini
+  - setuptools
+  - setuptools_scm[toml]
+  - pip
+  - pip:
+     - build
+     - twine
+     - praatio >= 5.0

docs/source/_static/css/style.css

@@ -0,0 +1,82 @@
+.wy-nav-content {
+    max-width: 1200px !important;
+}
+.wy-table-responsive table td {
+    white-space: normal !important;
+}
+.wy-table-responsive {
+    overflow: visible !important;
+}
+.wy-table-responsive table td,
+.wy-table-responsive table th {
+  white-space: normal;
+}
+
+:root {
+  --base-blue: 0, 53, 102;
+  --dark-blue: 0, 29, 61;
+  --light-blue: 14, 99, 179;
+  --base-yellow: 255, 195, 0;
+  --light-yellow: 255, 214, 10;
+  --pst-color-primary: var(--base-blue);
+  --pst-color-warning: var(--light-yellow);
+  --pst-color-info: var(--light-blue);
+
+    --pst-color-link: var(--light-blue);
+    --pst-color-link-hover: var(--dark-blue);
+
+    --pst-color-active-navigation: var(--dark-blue);
+    --pst-color-hover-navigation: var(--base-yellow);
+
+    --pst-color-navbar-link: var(--base-blue);
+    --pst-color-navbar-link-hover: var(--pst-color-hover-navigation);
+    --pst-color-navbar-link-active: var(--pst-color-active-navigation);
+
+    --pst-color-sidebar-link: var(--base-blue);
+    --pst-color-sidebar-caption: var(--base-blue);
+    --pst-color-sidebar-link-hover: var(--pst-color-hover-navigation);
+    --pst-color-sidebar-link-active: var(--pst-color-active-navigation);
+
+    --pst-color-toc-link: var(--base-blue);
+    --pst-color-toc-link-hover: var(--pst-color-hover-navigation);
+    --pst-color-toc-link-active: var(--pst-color-active-navigation);
+}
+.btn-navigation{
+    background-color: #0E63B3;
+    border-color: #0E63B3;
+}
+.btn-navigation:hover {
+    background-color: #FFC300;
+    border-color: #FFC300;
+    color: #000814;
+}
+.i-navigation{
+    color: #003566;
+    padding: 20px;
+}
+.i-navigation:hover {
+    color: #FFC300;
+}
+
+.rst-table-cell{
+width: 100%;
+height: 100%;
+display: inline-block;
+text-align: center;
+
+}
+
+.supported {
+background-color: #E9F6EC;
+}
+
+.not-supported {
+background-color: #FBEAEC;
+}
+#navbar-icon-links i.fa-github-square::before, i.fa-github-square::before {
+    color: inherit;
+}
+
+dt:target {
+background-color: #FFD60A;
+}