Skip to content

Generate the python documentation webpage #1076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sthibaul merged 1 commit into from
Jan 6, 2026
Merged

Generate the python documentation webpage #1076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,12 @@ the [speech dispatcher documentation](http://htmlpreview.github.io/?https://gith
the [spd-say documentation](http://htmlpreview.github.io/?https://github.com/brailcom/speechd/blob/master/doc/spd-say.html),
and the [SSIP protocol documentation](http://htmlpreview.github.io/?https://github.com/brailcom/speechd/blob/master/doc/ssip.html).

The python binding documentation is available with `pydoc3 speechd` (or `pydoc speechd`)
The python binding documentation is available on the shell with
`pydoc3 speechd` (or `pydoc speechd`)
and online, both the documentation for the
[direct mapping of the SSIP commands and logic](http://htmlpreview.github.io/?https://github.com/brailcom/speechd/blob/master/doc/speechd.client.SSIPClient.html)
and the
[more convenient interface](http://htmlpreview.github.io/?https://github.com/brailcom/speechd/blob/master/doc/speechd.client.Speaker.html)

The key features and the supported TTS engines, output subsystems, client
interfaces and client applications known to work with Speech Dispatcher are
Expand Down
3 changes: 3 additions & 0 deletions doc/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
/speech-dispatcher.dvi
/speech-dispatcher.html
/speech-dispatcher.info
/speechd.client.SSIPClient.html
/speechd.client.Speaker.html
/speechd.html
/ssip.dvi
/ssip.html
/ssip.info
Expand Down
9 changes: 9 additions & 0 deletions doc/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ if BUILD_HTML_DOC
all: html
endif

if HAVE_PYTHON
PYTHON_HTML = speechd.html speechd.client.SSIPClient.html speechd.client.Speaker.html
all: $(PYTHON_HTML)
endif

MAKEINFOHTML = $(MAKEINFO) --html --no-split

info_TEXINFOS = ssip.texi speech-dispatcher.texi spd-say.texi speech-dispatcher-cs.texi
Expand All @@ -28,6 +33,9 @@ speech_dispatcher_TEXINFOS = gpl.texi fdl.texi speech-dispatcher.texi
speech_dispatcher_cs_TEXINFOS = gpl.texi fdl.texi speech-dispatcher-cs.texi
ssip_TEXINFOS = gpl.texi fdl.texi

$(PYTHON_HTML): %.html: $(top_srcdir)/src/api/python/speechd/__init__.py $(top_srcdir)/src/api/python/speechd/client.py
PYTHONPATH=$(top_builddir)/src/api/python pydoc3 -w $*

CLEANFILES = spd-say.info \
speech-dispatcher-cs.info \
speech-dispatcher.info \
Expand All @@ -44,6 +52,7 @@ DISTCLEANFILES = \
speech-dispatcher-cs.dvi \
speech-dispatcher.html \
speech-dispatcher.dvi \
$(PYTHON_HTML) \
ssip.html \
ssip.dvi \
mdate-sh \
Expand Down
Loading
Loading