簡體   English   中英

與主管交流Python腳本的最簡單方法?

[英]The easiest way to communicate a Python script to supervisors?

我完成了第一個初稿,想知道如何最有效地將代碼傳達給非Python用戶。 我在想一個HTML或PDF文件(也許是jupyter筆記本樣式),該文件可以清晰地顯示代碼及其呈現的輸出,並提供一些文本來徹底解釋每個步驟的完成情況。 我看到Markdown似乎是用於此目的的程序包,但我想知道在閱讀程序包特定的語法之前是否有更簡單的方法來解決它。

看看Sphinx: http//www.sphinx-doc.org/en/master/

這是一個庫,可讓您為項目生成具有專業外觀的文檔。 我自己用它來向管理人員介紹我的想法/代碼。 結果看起來非常專業,並且非常易於使用。 我會避免Markdown。 獅身人面像看起來好多了。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM