merging sphinxapi-doc output

40 views
Skip to first unread message

Denis CARDON

unread,
Jul 16, 2021, 7:36:54 AM7/16/21
to sphinx...@googlegroups.com
Hi everyone,

I have a question on sphinx-apidoc for merging apidoc ouput in one
sphinxdoc. My issue : I have a project (wapt[1]) which use python for
deployment scripting on Windows, Linux and MacOS. The scripting is
written using helpers function which we call setuphelpers. Those
functions are mostly common among all the platform, but some are
platform specific, and can only be loaded on that specific platform.

As sphinx-apidoc import the modules, setuphelpers Python module for
Windows can only be loaded on Windows, the same for linux and macOS.
Running Sphinx-ApiDoc gives me the right output for each platform, but I
would like to merge them into one sphinx document, with something like
this in the rtd menu :

* setuphelpers for Windows

* setuphelpers for Linux

* setuphelpers for macOS

Sphinx-build with sphinx.ext.autodoc only output only html. Is there a
way to tell sphinx.ext.autodoc to output intermediate RST files in order
to merge them into a unified document?

Thanks,

Denis

[1] https://github.com/tranquilit/WAPT

Komiya Takeshi

unread,
Jul 17, 2021, 12:26:50 AM7/17/21
to sphinx...@googlegroups.com
Hi,

> Is there a way to tell sphinx.ext.autodoc to output intermediate RST files in order to merge them into a unified document?

Unfortunately, there is no such option. autodoc generates intermediate
reST documents and processes them on the fly.

Thanks,
Takeshi KOMIYA

2021年7月16日(金) 20:36 'Denis CARDON' via sphinx-users
<sphinx...@googlegroups.com>:
> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/1d3bfc31-ba50-6f9a-f75d-ce7ad63fd664%40tranquil.it.
Reply all
Reply to author
Forward
0 new messages