Benoit Chesneau 46e7726838 fix: make syslog_addr default platform-neutral in docs
The syslog_addr setting has different defaults depending on the
platform (macOS, FreeBSD, OpenBSD, Linux). Added default_doc to
show all platform-specific defaults in the documentation, ensuring
consistent output regardless of which platform generates the docs.

Also kept the diagnostic git diff in CI for future debugging.
2026-01-23 10:08:01 +01:00
..
2026-01-23 01:20:03 +01:00
2026-01-23 01:20:03 +01:00

Generate Documentation
======================

Requirements
------------

Install the documentation dependencies with::

    pip install -r requirements_dev.txt

This provides MkDocs with the Material theme and supporting plugins.


Build static HTML
-----------------
::

    mkdocs build

The rendered site is emitted into the ``site/`` directory.


Preview locally
---------------
::

    mkdocs serve

This serves the documentation at http://127.0.0.1:8000/ with live reload.