christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-04 19:03:39 +00:00
Code Issues Releases Activity

docs: build docs in CI (and be nitpicky about it)

Browse Source 
This ensures that any warning generated from compiling the docs is treated as
an error. Also, building the docs is now one of the steps performed in CI.
This commit is contained in:
Régis Behmo 2021-09-16 11:48:59 +02:00 committed by Régis Behmo
parent 07ae8d472f
commit 2f24a40d99
3 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/test.yml vendored
View File

@ -29,3 +29,7 @@ jobs:
run: make test-format run: make test-format
- name: Package tests - name: Package tests
run: make test-pythonpackage run: make test-pythonpackage
- name: Install docs dependencies
run: pip install -r requirements/docs.txt
- name: Build docs
run: make docs

2
docs/Makefile
View File

@ -2,7 +2,7 @@
.PHONY: help .PHONY: help
html: html:
sphinx-build -b html -a -E "." "_build/html" sphinx-build -b html -a -E -n -W "." "_build/html"
browse: browse:
sensible-browser _build/html/index.html sensible-browser _build/html/index.html

4
docs/run.rst
View File

@ -5,7 +5,7 @@ Running Open edX
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
local local
k8s k8s
dev dev