Skip to content

Commit

Permalink
Update git_pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dan5e3s6ares committed Aug 19, 2024
1 parent 51c297a commit c2cf8ed
Show file tree
Hide file tree
Showing 127 changed files with 11,160 additions and 9 deletions.
31 changes: 23 additions & 8 deletions .github/workflows/git_pages.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
name: documentation

on:
push:
branches:
- main
pull_request:
types: [opened, synchronize, reopened]
on: [push, pull_request, workflow_dispatch]

permissions:
contents: write

jobs:
publish-page:
uses: dan5e3s6ares/git_actions_workflows/.github/workflows/publish-page.yaml@main
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser sphinx-design sphinx-book-theme
- name: Sphinx build
run: |
sphinx-build docs/source _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: feature/GithubPages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ instance/
.scrapy

# Sphinx documentation
docs/_build/
# docs/_build/

# PyBuilder
.pybuilder/
Expand Down
4 changes: 4 additions & 0 deletions docs/_build/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: abaa7dc07366bd02a825a8a66386aa8c
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/_build/.doctrees/CODE_OF_CONDUCT.doctree
Binary file not shown.
Binary file added docs/_build/.doctrees/CONTRIBUTING.doctree
Binary file not shown.
Binary file added docs/_build/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/.doctrees/help.doctree
Binary file not shown.
Binary file added docs/_build/.doctrees/index.doctree
Binary file not shown.
Binary file added docs/_build/.doctrees/mocking.doctree
Binary file not shown.
Binary file added docs/_build/.doctrees/scenarios.doctree
Binary file not shown.
Binary file added docs/_build/.doctrees/sponsor.doctree
Binary file not shown.
Binary file added docs/_build/.doctrees/thanks.doctree
Binary file not shown.
Binary file added docs/_build/.doctrees/ways_to_use.doctree
Binary file not shown.
Loading

0 comments on commit c2cf8ed

Please sign in to comment.