撰寫文件¶
備註
本節僅簡要記述,詳細作法請直接參考 Writing documentation
文件編輯方法¶
安裝本文件於 Python 虛擬環境¶
新增一個 Python 虛擬環境(virtualenv)供文件使用,並進入該虛擬環境
sudo apt install python3-dev python3-pip python3-venv git
python3 -m venv pyenv
. pyenv/bin/activate
pip install setuptools==44.1.0
pip install -e 'git+git://github.com/depositar/ckan.git#egg=ckan[requirements]'
pip install -e 'git+https://github.com/depositar/ckanext-data-depositario.git#egg=ckanext-data-depositario'
pip install -r pyenv/src/ckanext-data-depositario/requirements-docs.txt
文件產生方法¶
在發佈文件之前,請先於本機測試生成供發佈用之 HTML 檔案。指令如下
cd pyenv/src/ckanext-data-depositario
python setup.py build_sphinx
您即可使用瀏覽器開啟 build/sphinx/html/index.html
檔案瀏覽生成之 HTML 檔案。
重要
請務必確保執行此文件生成指令時,無產生任何警告(warnings)。建議將整個 build
目錄移除以再次確認:
rm -rf build; python setup.py build_sphinx
文件發佈方法¶
本文件使用 ReadTheDocs 服務發佈。您只要完成修改後,利用 git push
指令將 ckanext-data-depositario 推送至 GitHub,數分鐘後 ReadTheDocs 即會自動生成新版文件。