From dd21619228976712750a6edafc60a08f2eab761c Mon Sep 17 00:00:00 2001 From: TAKAHASHI Shuuji Date: Tue, 29 Nov 2022 02:24:45 +0900 Subject: [PATCH] Fix docs code block and separate docs tests --- .github/workflows/test-docs.yml | 23 +++++++++++++++++++++++ .github/workflows/test.yml | 8 +++++++- docs/contributing.rst | 2 +- 3 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/test-docs.yml diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml new file mode 100644 index 0000000..070ce7a --- /dev/null +++ b/.github/workflows/test-docs.yml @@ -0,0 +1,23 @@ +name: Test Documentation Build + +on: [push, pull_request] + +jobs: + test_docs: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.10"] + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: pip + - name: Install dependencies for docs + run: | + python -m pip install -r docs/requirements.txt + - name: Build documentation + run: | + cd docs && make clean && make html diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index e62604e..5122986 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,6 +1,12 @@ name: Test -on: [push, pull_request] +on: + push: + paths-ignore: + - 'docs/**' + pull_request: + paths-ignore: + - 'docs/**' jobs: test: diff --git a/docs/contributing.rst b/docs/contributing.rst index 34a93a7..d7b8842 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -101,7 +101,7 @@ You will need to run Stator in order to have background actions work:: ./manage.py runstator -Make yourself a superuser account in order to log in: +Make yourself a superuser account in order to log in:: ./manage.py createsuperuser