撰寫文件

備註

本節僅簡要記述,詳細作法請直接參考 Writing documentation

文件編輯方法

安裝本文件於 Python 虛擬環境

新增一個 Python 虛擬環境(virtualenv)供文件使用,並進入該虛擬環境

sudo apt-get install python-dev libpq-dev python-pip python-virtualenv
virtualenv --no-site-packages pyenv
. pyenv/bin/activate
pip install -e 'git+https://github.com/depositar-io/ckanext-data-depositario.git#egg=ckanext-data-depositario'
cd pyenv/src/ckanext-data-depositario
pip install -r requirements-docs.txt
cd ../ckan
pip install -r requirements.txt
pip install setuptools==36.1

開始編輯

文件原始碼均位於 pyenv/src/ckanext-data-depositario/doc 目錄下,使用 Sphinx 建立,內容以 reStructuredText 語法撰寫,您可以參考以下連結的介紹:

文件產生方法

在發佈文件之前,請先於本機測試生成供發佈用之 HTML 檔案。指令如下

cd ../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 即會自動生成新版文件。