安裝
pip install sphinx
文件完整的結構目錄如下：
image.png
在自己的項目目錄下建立兩個文件夾src和doc
在src下新建一個文件demo1.py慎菲，內容如下：
# 使用類和實例
class Car():
"""一次模擬汽車的簡單嘗試"""
def __init__(self, make, model, year):
"""初始化描述汽車的屬性"""
self.make = make
self.model = model
self.year = year
# 給屬性指定默認值
self.odometer_reading = 0
def get_descriptive_name(self):
""" 返回整潔的描述性信息 """
long_name = str(self.year) + ' ' + self.make + ' ' + self.model
return long_name.title()
def read_odometer(self):
""" 打印一條指出汽車里程的消息 """
print('This car has ' + str(self.odometer_reading) + ' miles on it.')
def update_odometer(self, mileage):
""" 修改里程的值 """
if mileage >= self.odometer_reading:
self.odometer_reading = mileage
else:
print("You can't roll back an odometer!")
def increment_odometer(self, miles):
""" 將里程表讀數(shù)增加指定的量 """
self.odometer_reading += miles
接著執(zhí)行以下命令
cd doc
sphinx-quickstart
打開doc/source/conf.py文件组哩，取消13-15行的注釋
第15行sys.path.insert(0, os.path.abspath('.')) 改為sys.path.insert(0, os.path.abspath('../../src'))
在doc目錄下執(zhí)行
sphinx-apidoc -o source ../src
- source參數(shù)是doc文件夾下的source文件夾
- ../src 參數(shù)是和doc文件夾同級的放Python文件的文件夾
執(zhí)行后會生成如下文件
image.png
如在編譯時遇到錯誤 Sphinx error: master file [..]/checkouts/latest/contents.rst not found
可以在doc/source/conf.py 中添加master_doc = 'index'
執(zhí)行make html生成 html 格式的文檔蜈缤，在build/html文件夾下會生成相應的文檔
點擊index.html頁面查看效果：
image.png
再往index.rst里添加好模塊的名稱
image.png
再去執(zhí)行make html宠页，剛剛添加的內容就會在首頁的導航里出現(xiàn)了
image.png
點擊鏈接后跳轉如下：
image.png
