3 ms·
(I've provided this feedback in the past to readthedocs several times, but never even got an acknowledgement.) My project has a C module as part of the project
by rogerbinns 10y ago
(I've provided this feedback in the past to readthedocs several times, but never even got an acknowledgement.)
My project has a C module as part of the project, and the documentation (in rst format) is generated. However to generate it requires a "compilation" step, which rtd does not support. "make docs" will correctly do everything necessary.
Sadly rtd tools want to be in charge of all steps, and provide no way of doing the initial build and file generation.
- vbernat 10y agoIsn't conf.py executed? You should be able to put whatever execution step you want in it.
- rogerbinns 10y agoThe last step is to run sphinx-build, and that is what uses conf.py. Before that, the following is done: - Compile the code/module - Run the example code capturing various pieces of output, putting the final result into a generated .rst file - Generating more .rst files from various C file sources - Some additional doc updates (eg inserting some version related info, updating help sections with current --help information for cli tools). These are up to date in git, so rtd wouldn't need to run them, but I do for each release