sphinx-me

獅身人面像，我是一個Python的工具，將為您的項目獅身人面像文檔殼，包括自述文件中的文檔索引＆NBSP;它可以處理提取所需的元數據，如項目名稱，作者，版本從您項目在您的獅身人面像文檔使用。
一旦你使用獅​​身人面像，我建立的獅身人面像文檔，那麼你就可以在你的項目添加到閱讀文檔的網站，有你的項目的自述舉辦一個有吸引力的獅身人面像文檔主題。
注意：您的README文件應在reStructuredText的兼容格式。
安裝
最簡單的方法來安裝獅身人面像，我是直接從PyPI上使用PIP或setuptools的運行下面的命令分別：
PIP安裝-U獅身人面像，我
或：
easy_install的-U獅身人面像，我
否則，你可以下載獅身人面像，我直接從源代碼安裝：
蟒蛇setup.py安裝
運行
獅身人面像，我將安裝為，可以通過命令行，同時在項目的根目錄下運行全系統的腳本：
獅身人面像，我
當你的項目的目錄中運行，它會創建兩個文件，獅身人面像conf.py模塊和index.rst文件，其中包括項目的README一個文檔目錄。
該conf.py模塊調用從設置功能獅身人面像，我設置了最低要求設置您的獅身人面像文檔。
- 項目 - 項目的目錄名稱使用。
- 版 - 從你的setup.py腳本，或者你的包的__version__屬性的版本ARG檢索。
- 版權 - 從你的setup.py腳本，或者你的包的__author__屬性的作者ARG檢索

要求：

• 。蟒蛇