doc/python: integrate sphinxHook docs

Improve the documentation by moving it from the hook script into the
Python section in the manual and adding code examples.
This commit is contained in:
Martin Weinelt
2022-08-24 23:02:24 +02:00
parent 1ee5fcaf0c
commit 8a26deba06
2 changed files with 48 additions and 13 deletions
@@ -1,16 +1,3 @@
# This hook automatically finds Sphinx documentation, builds it in html format
# and installs it.
#
# This hook knows about several popular locations in which subdirectory
# documentation may be, but in very unusual cases $sphinxRoot directory can be
# set explicitly.
#
# Name of the directory relative to ${doc:-$out}/share/doc is normally also
# deduced automatically, but can be overridden with $sphinxOutdir variable.
#
# Sphinx build system can depend on arbitrary amount of python modules, client
# code is responsible for ensuring that all dependencies are present.
# shellcheck shell=bash
echo "Sourcing sphinx-hook"