Update README.md #180
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: doc | |
on: | |
push: | |
branches: ["main"] | |
# Prevent doc action on `main` to conflict with each others. | |
concurrency: | |
group: doc-${{ github.ref }} | |
cancel-in-progress: true | |
jobs: | |
doc: | |
runs-on: "ubuntu-latest" | |
timeout-minutes: 30 | |
defaults: | |
run: | |
shell: bash -l {0} | |
steps: | |
- name: Checkout the code | |
uses: actions/checkout@v3 | |
- name: Setup mamba | |
uses: mamba-org/setup-micromamba@v1 | |
with: | |
environment-file: env.yml | |
environment-name: graphium | |
cache-environment: true | |
cache-downloads: true | |
- name: Install library | |
run: | | |
python -m pip install --no-deps . | |
pip install typer-cli | |
- name: Configure git | |
run: | | |
git config --global user.name "${GITHUB_ACTOR}" | |
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" | |
- name: Deploy the doc | |
run: | | |
echo "Auto-generating typer docs" | |
typer graphium.cli.__main__ utils docs --name graphium --output docs/cli/graphium.md | |
echo "Get the gh-pages branch" | |
git fetch origin gh-pages | |
echo "Build and deploy the doc on main" | |
mike deploy --push --force main |