Sphinx是一款支持多种编程语言的文档生成工具,可以由reStructuredText或Markdown文档生成HTML静态网页,并且自动生成索引,可以作为个人网站、博客,或者制作电子教程、书籍等。
1.安装Python
Python官网(https://www.python.org/)下载安装Python3+。
2.安装sphinx
pip install sphinx
3.安装markdown支撑的模块
pip install sphinx-markdown-tables
4.安装主题模板
pip install sphinx-rtd-theme
5.创建项目文件夹test并进入
6.启动Sphinx,输入以下信息
Project name:Python教程
Author name(s):zbxx.net
Project language [en]:zh_CN
启动Sphinx后会在项目文件夹test中创建如下文件结构:
7.编辑 source/conf.py 文件
extensions = ['recommonmark','sphinx_markdown_tables']
html_theme = 'sphinx_rtd_theme'
8.将markdown笔记文件Python.md放到source目录下
9.编辑 source/index.rst 文件,加入python.md
10.生成HTML
make html
生成静态HTML网页文件,位置:buildhtml,我们就拥有了一个完整的静态网站。
打开index.html预览效果,可以本地使用或上传个人网站。
markdown笔记修改后,需要清空HTML,重新生成。
make clean
页面更新:2024-04-26
本站资料均由网友自行发布提供,仅用于学习交流。如有版权问题,请与我联系,QQ:4156828
© CopyRight 2020-2024 All Rights Reserved. Powered By 71396.com 闽ICP备11008920号-4
闽公网安备35020302034903号