Skip to content

ci, doc: Add warning-as-error to Sphinx options

Eduardo Almeida requested to merge edalm/ns-3-dev:doc-fix-references into master

Add flags to Sphinx Makefile to enable warning-as-error. This allows detecting Sphinx warnings and prevent future regressions.

The flags added are explained in the Sphinx documentation:

  • -W: Turn warnings into errors.
  • --keep-going: Do not stop at the first error.

TO DO

  • Add flags to Sphinx Makefiles.
  • Fix Sphinx warnings. Fix #1034 (closed).
  • Do not set the documentation language. Sphinx 5.0.0 no longer accepts language = None. Either a language is explicitly set or this line is commented and it English is assumed.
Edited by Eduardo Almeida

Merge request reports