ReadTheDocs：将预构建的 HTML 页面发布到 ReadTheDocs

Question

I was trying to create documentation from python doc strings, and found pdoc. If you don't know, it creates html documentation from python doc strings. Since it generates .html files and not .rst , how do I publish those to ReadTheDocs or generate .rst files using pdoc?

Quick sidenote: I don't want to use sphinx since 1) the theme pdoc has is pretty cool and 2) I don't know how to generate documentation from docstrings using sphinx (all the tutorials I looked at didn't help).

Answer 1

Read the Docs released a beta feature some time ago that allows you to completely override the build process. This means that you can execute custom commands (eg pdoc ) and output all the HTML to a particular directory ( _readthedocs/html ). Once the build is finished, Read the Docs will publish the content of that directory.

Check out the documentation at https://docs.readthedocs.io/en/stable/build-customization.html#override-the-build-process