与主管交流Python脚本的最简单方法？

Question

I finished my first draft-computation and was wondering how to most effectively communicate the code to non-Python users. I was thinking of a HTML or PDF file (maybe in jupyter notebook style) that allows to neatly show the code with it's rendered outputs, as well as some text to thoroughly explain what is done in every step. I saw that Markdown seems to be a package for that purpose, but I was wondering whether there is a easier way to go about it, before I read into the package specific syntax.

Answer 1

Have a look at Sphinx: http://www.sphinx-doc.org/en/master/

This is a library which allows you to generate professional looking documentation for your projects. I have used it myself to present my ideas / code to management. The results look very professional and it is pretty easy to use. I would avoid Markdown. Sphinx looks a lot better.