update github.io page

This commit is contained in:
jmwang66 2022-12-26 16:43:33 +08:00
parent 9ec68fe1bc
commit b3c6ccc110
10 changed files with 124 additions and 3 deletions

BIN
.DS_Store vendored Normal file

Binary file not shown.

32
.github/workflows/main.yml vendored Normal file
View File

@ -0,0 +1,32 @@
name: "FunASR Docs"
on:
pull_request:
branches:
- main
push:
branches:
- dev
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
pre-build-command: "pip install sphinx-markdown-tables nbsphinx jinja2 recommonmark sphinx_rtd_theme"
- name: deploy copy
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
run: |
mkdir public
cp -r docs/build/html/* public/
- name: deploy github.io pages
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
uses: peaceiris/actions-gh-pages@v2.3.1
env:
GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
PUBLISH_BRANCH: gh-pages
PUBLISH_DIR: public

3
.idea/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
# Default ignored files
/shelf/
/workspace.xml

12
.idea/FunASR.iml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
<component name="PyDocumentationSettings">
<option name="format" value="PLAIN" />
<option name="myDocStringFormat" value="Plain" />
</component>
</module>

View File

@ -0,0 +1,50 @@
<component name="InspectionProjectProfileManager">
<profile version="1.0">
<option name="myName" value="Project Default" />
<inspection_tool class="PyPackageRequirementsInspection" enabled="true" level="WARNING" enabled_by_default="true">
<option name="ignoredPackages">
<value>
<list size="37">
<item index="0" class="java.lang.String" itemvalue="sentencepiece" />
<item index="1" class="java.lang.String" itemvalue="pyyaml" />
<item index="2" class="java.lang.String" itemvalue="parameterized" />
<item index="3" class="java.lang.String" itemvalue="rouge" />
<item index="4" class="java.lang.String" itemvalue="nose2" />
<item index="5" class="java.lang.String" itemvalue="timm" />
<item index="6" class="java.lang.String" itemvalue="mypy" />
<item index="7" class="java.lang.String" itemvalue="tensorboardX" />
<item index="8" class="java.lang.String" itemvalue="torch" />
<item index="9" class="java.lang.String" itemvalue="blobfile" />
<item index="10" class="java.lang.String" itemvalue="torchvision" />
<item index="11" class="java.lang.String" itemvalue="einops" />
<item index="12" class="java.lang.String" itemvalue="editdistance" />
<item index="13" class="java.lang.String" itemvalue="soundfile" />
<item index="14" class="java.lang.String" itemvalue="typeguard" />
<item index="15" class="java.lang.String" itemvalue="torchaudio" />
<item index="16" class="java.lang.String" itemvalue="kaldiio" />
<item index="17" class="java.lang.String" itemvalue="webdataset" />
<item index="18" class="java.lang.String" itemvalue="g2p" />
<item index="19" class="java.lang.String" itemvalue="flake8-executable" />
<item index="20" class="java.lang.String" itemvalue="pyflakes" />
<item index="21" class="java.lang.String" itemvalue="textgrid" />
<item index="22" class="java.lang.String" itemvalue="flake8-pyi" />
<item index="23" class="java.lang.String" itemvalue="pycodestyle" />
<item index="24" class="java.lang.String" itemvalue="flake8-bugbear" />
<item index="25" class="java.lang.String" itemvalue="flake8-comprehensions" />
<item index="26" class="java.lang.String" itemvalue="flake8" />
<item index="27" class="java.lang.String" itemvalue="shapely" />
<item index="28" class="java.lang.String" itemvalue="submitit" />
<item index="29" class="java.lang.String" itemvalue="tensorboard" />
<item index="30" class="java.lang.String" itemvalue="matplotlib" />
<item index="31" class="java.lang.String" itemvalue="ftfy" />
<item index="32" class="java.lang.String" itemvalue="sacremoses" />
<item index="33" class="java.lang.String" itemvalue="efficientnet_pytorch" />
<item index="34" class="java.lang.String" itemvalue="pytorch_lightning" />
<item index="35" class="java.lang.String" itemvalue="rouge_score" />
<item index="36" class="java.lang.String" itemvalue="torch_complex" />
</list>
</value>
</option>
</inspection_tool>
</profile>
</component>

View File

@ -0,0 +1,6 @@
<component name="InspectionProjectProfileManager">
<settings>
<option name="USE_PROJECT_PROFILE" value="false" />
<version value="1.0" />
</settings>
</component>

4
.idea/misc.xml Normal file
View File

@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectRootManager" version="2" project-jdk-name="Python 3.7 (funasr_doc)" project-jdk-type="Python SDK" />
</project>

8
.idea/modules.xml Normal file
View File

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/FunASR.iml" filepath="$PROJECT_DIR$/.idea/FunASR.iml" />
</modules>
</component>
</project>

6
.idea/vcs.xml Normal file
View File

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>

View File

@ -3,9 +3,9 @@
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".