Turn all warnings into errors when building website

Drop code target, sphinx-autogen is not using conf.py, and since Sphinx
4.0 autosummary is generating stub pages by default anyway.

Mock ctypes and linkcheck.__main__: colorama.py imports MS Windows
libraries, autosummary executes __main__.py.
This commit is contained in:
Chris Mayo 2022-11-02 19:24:35 +00:00
parent 0a8c29ffcc
commit c7989eb058
6 changed files with 4 additions and 12 deletions

View file

@ -111,7 +111,6 @@ jobs:
- name: Build
run: |
python3 -m hatchling build -t sdist --hooks-only
make -C doc code
make -C doc html
make -C doc locale
make -C doc man

View file

@ -36,7 +36,6 @@ jobs:
- name: Build
run: |
python3 -m hatchling build -t sdist --hooks-only
make -C doc code
make -C doc html
- name: Publish

View file

@ -3,10 +3,7 @@ LOCALES:=en de
all: html man
code: clean
python3 -m sphinx.ext.autosummary.generate src/code/index.rst
html:
html: clean
make -C src html
locale:

View file

@ -44,11 +44,6 @@ Published man pages are included in the LinkChecker repository.
HTML
----
``doc/src/code/index.rst`` gives an overview of the LinkChecker code, optionally a navigable
copy of the LinkChecker source can be created with:
``linkchecker/doc $ make code``
Build the HTML files with:
``linkchecker/doc $ make html``

View file

@ -1,6 +1,6 @@
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXOPTS ?= -W --keep-going
SPHINXBUILD ?= python3 -m sphinx.cmd.build
SPHINXINTL ?= python3 -m sphinx_intl.commands
SOURCEDIR = .

View file

@ -78,6 +78,8 @@ autodoc_member_order = 'groupwise'
autosectionlabel_prefix_document = True
autosummary_mock_imports = ['ctypes', 'linkcheck.__main__']
extlinks = {'pypi': ('https://pypi.org/project/%s/', '%s')}
graphviz_output_format = 'svg'