Updated docs.yaml on for github actions #2
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: ssl_tools | |
on: | |
push: | |
branches: | |
- main | |
jobs: | |
docs: | |
name: SSL tools documentation | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Install Python | |
uses: actions/setup-python@v1 | |
with: | |
python-version: 3.12.1 | |
- name: Install requirements | |
run: | | |
pip3 install sphinx sphinx-rtd-theme sphinx-autodoc-typehints sphinx-argparse sphinx-autoapi nbsphinx pandoc | |
- name: Build docs | |
run: | | |
cd docs | |
make html | |
# https://github.com/peaceiris/actions-gh-pages | |
- name: Deploy | |
if: success() | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/_build/html/ |