docs: build docs in CI (and be nitpicky about it)
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:
parent
07ae8d472f
commit
2f24a40d99
|
@ -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,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
|
||||||
|
|
|
@ -5,7 +5,7 @@ Running Open edX
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
local
|
local
|
||||||
k8s
|
k8s
|
||||||
dev
|
dev
|
||||||
|
|
Loading…
Reference in New Issue