Skip to content

Auto build docs #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
BryanRumsey wants to merge 3 commits into from
Closed

Auto build docs #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a37ca9
Start here update.
BryanRumsey Feb 23, 2022
40b881a
Added github action to automatically update the docs on a push to mai…
BryanRumsey Feb 23, 2022
b6c3468
Updated make target.
BryanRumsey Feb 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/update-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Publish SpatialPy Docs

on:
push:
branches: [main]

jobs:
publish:
runs-on: ubuntu-latest

steps:
- name: Update and Publish docs
- run: cd docs && make publish-release
15 changes: 15 additions & 0 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,21 @@ publish:
git checkout @{-1}
git stash pop

publish-release:
make clean
git stash
git checkout main
make html
-git add -f "$(BUILDDIR)"
-git commit -m "Latest build." "$(BUILDDIR)"
git push origin main -f
make clean
git checkout gh-pages
git pull origin main
git push origin gh-pages -f
git checkout @{-2}
git stash pop

apidocs: build-dir
sphinx-apidoc -f -T -o classes ../spatialpy

Expand Down
Loading