Set up install for doc-build
This commit is contained in:
parent
97b6be7bce
commit
d4e1e537cd
3 changed files with 14 additions and 5 deletions
17
.github/workflows/github_action_build_docs.yml
vendored
17
.github/workflows/github_action_build_docs.yml
vendored
|
|
@ -19,7 +19,6 @@ jobs:
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
python-version: [3.7]
|
python-version: [3.7]
|
||||||
TESTING_DB: ['sqlite3']
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
|
@ -29,19 +28,31 @@ jobs:
|
||||||
with:
|
with:
|
||||||
python-version: ${{ matrix.python-version }}
|
python-version: ${{ matrix.python-version }}
|
||||||
|
|
||||||
- name: Install package dependencies
|
- name: Install doc-building dependencies
|
||||||
run: |
|
run: |
|
||||||
python -m pip install --upgrade pip
|
python -m pip install --upgrade pip
|
||||||
cd docs/
|
cd docs/
|
||||||
make install
|
make install
|
||||||
|
|
||||||
|
# fail early here
|
||||||
- name: Quick-test docs (no autodocs)
|
- name: Quick-test docs (no autodocs)
|
||||||
|
continue-on-error: true
|
||||||
run: |
|
run: |
|
||||||
cd docs/
|
cd docs/
|
||||||
make quick
|
make quick
|
||||||
|
|
||||||
|
# full game dir needed for mv-local
|
||||||
|
- name: Set up evennia game dir
|
||||||
|
run: |
|
||||||
|
pip install -e .
|
||||||
|
cd ..
|
||||||
|
evennia --init gamedir
|
||||||
|
cd gamedir
|
||||||
|
evennia migrate
|
||||||
|
|
||||||
- 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'}}
|
||||||
run: |
|
run: |
|
||||||
cd docs/
|
cd docs
|
||||||
|
make mv-local
|
||||||
echo "Would deploy here!"
|
echo "Would deploy here!"
|
||||||
|
|
|
||||||
|
|
@ -107,7 +107,6 @@ 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-html-build $(FILES)
|
make _quick-html-build $(FILES)
|
||||||
@echo ""
|
@echo ""
|
||||||
@echo "Documentation built (single version, no autodocs)."
|
@echo "Documentation built (single version, no autodocs)."
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
# VERSION WARNING
|
# VERSION WARNING
|
||||||
|
|
||||||
> This is the experimental static v0.9 documentation of Evennia, _automatically_ generated from the
|
> This is the experimental static v0.9 documentation of Evennia, _automatically_ generated from the
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue