杜郎俊赏 - dujun.io

开源实例之Sphinx

前言

Sphinx makes it easy to create intelligent and beautiful documentation.

Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

Sphinx 使用 reStructuredText 作为标记语言,它的许多优势来自 reStructuredText 及其解析和翻译套件 Docutils 的强大功能和直接性,可以轻松创建智能美观的文档。

实例地址

http://sphinx.dujun.eu.org

实例配置

配置描述
系统Debian
开发环境服务端Python 3.9
服务器Nginx
程序Sphinx 6.1.3
数据sphinx_rtd_theme

实例部署

权限要求

  • 具有系统读写权限
  • 已安装 Python
  • 已安装 Nginx

安装程序

官网地址:https://www.sphinx-doc.org
程序仓库:https://github.com/sphinx-doc/sphinx
数据仓库:https://github.com/readthedocs/sphinx_rtd_theme

#克隆代码
git clone https://github.com/readthedocs/sphinx_rtd_theme.git

#安装依赖
cd sphinx_rtd_theme/docs/
pip install -r requirements.txt

#生成静态文件
make html

实例体验

进入实例深度体验

后记

本实例仅供参考,不定期重置数据。

体验更多开源实例

标签: 开源实例 Python开源实例 文档生成工具开源实例 生产开源实例
日期:2023-06-18