/cookiecutter-sphinx-doc

a cookiecutter template for sphinx with markdown gen pdf and html

Primary LanguagePythonMIT LicenseMIT

cookiecutter-sphinx-doc

一个项目模板基于cookiecutter

用法

pip install cookiecutter
cookiecutter https://github.com/yishenggudou/cookiecutter-sphinx-doc.git

example

(python3) ➜  /tmp cookiecutter https://github.com/yishenggudou/cookiecutter-sphinx-doc.git
You've downloaded /Users/timgerk/.cookiecutters/cookiecutter-sphinx-doc before. Is it okay to delete and re-download it? [yes]: yes
project []: simple doc project
project_slug []: sdp
book_title []: 项实例项目
author []: 作者
version [0.0.1]: 
release [0.0.1]: 
description []: 长的简介
src []: docs

然后进入docs 看到

(python3) ➜  docs tree
.
├── Makefile
├── conf.py
├── index.rst
├── intro.md
├── make.bat
├── plantuml.jar
├── releasenotes.py
├── test.rst
└── topdf.sh

0 directories, 9 files

生成html

make html

生成pdf

pip install -r requirements.txt
./topdf.sh

文件实例 pdf实例文件

特点

  1. 支持markdown
  2. 支持planuml
  3. pdf中文支持

依赖

  1. mactex
  2. planuml
  3. httpdomain
  4. 其他插件

注意

测试仅在mac环境下验证了python3 建议2的用户 virtualenv 到 3

关注微信公众号