Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More work on doc deployment

Browse source
This commit is contained in:
Griatch 2022-01-21 00:47:11 +01:00
parent a875ded18b
commit b332a2a205
2 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
.github/workflows/github_action_build_docs.yml vendored
View file

@ -36,10 +36,10 @@ jobs:
make install make install
# fail early here, run quickstrict with aborts also on warnings # fail early here, run quickstrict with aborts also on warnings
- name: Quick-test docs (no autodocs) # - name: Quick-test docs (no autodocs)
run: | # run: |
cd docs/ # cd docs/
make quickstrict # make quickstrict
- name: Deploy docs (only from master/develop branch) - name: Deploy docs (only from master/develop branch)
if: ${{ github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/master'}} if: ${{ github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/master'}}
@ -48,4 +48,4 @@ jobs:
git config --global user.name "Doc builder mechanism" git config --global user.name "Doc builder mechanism"
cd docs cd docs
make mv-local make mv-local
echo "Would deploy here!" make deploy

3
docs/Makefile
View file

@ -110,8 +110,9 @@ pdf:
@echo "To see result, open evennia/docs/build/latex/evennia.pdf in a PDF reader." @echo "To see result, open evennia/docs/build/latex/evennia.pdf in a PDF reader."
quick: quick:
make _check-env
make _quick_autodoc-index make _quick_autodoc-index
make _quick-html-build $(FILES) make _html-build
@echo "" @echo ""
@echo "Documentation built (single version, no autodocs)." @echo "Documentation built (single version, no autodocs)."
@echo "To see result, open evennia/docs/build/html/index.html in a browser." @echo "To see result, open evennia/docs/build/html/index.html in a browser."