From 841414bed1ea8322655ed750686ea8f57adf7794 Mon Sep 17 00:00:00 2001 From: Andrea Franchini <hello@andreafranchini.com> Date: Wed, 30 Nov 2022 11:46:22 +0100 Subject: [PATCH] add CI for docs --- .github/workflows/docs.yml | 22 ++++++++++++++++++++++ docs/conf.py | 2 +- docs/requirements.txt | 1 + 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/requirements.txt diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..59eb89b --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,22 @@ +name: Pages +on: + push: + branches: + - master +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/setup-python@v2 + - uses: actions/checkout@master + with: + fetch-depth: 0 # otherwise, you will failed to push refs to dest repo + - name: Build and Commit + uses: sphinx-notes/pages@v2 + with: + requirements_path: ./docs/requirements.txt + - name: Push changes + uses: ad-m/github-push-action@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: gh-pages \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index bc79858..e9248c7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,7 +41,7 @@ templates_path = [] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'requirements.txt'] # -- Options for HTML output ------------------------------------------------- diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..1f583ed --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx-rtd-theme == 1.1 \ No newline at end of file -- GitLab