关于sphinx

Sphinx将reStructuredText文件转换为HTML网站和其他格式,包括PDF、EPUB、Texinfo和man。
reStructuredText是可扩展的,Sphinx通过许多扩展来利用其可扩展性 — 用于从源代码自动生成文档、编写数学符号或突出显示源代码等。

安装sphinx

pkg install -y py38-sphinx

安装autobuild

pkg install -y py38-sphinx-autobuild

安装主题

pkg install -y py38-sphinx_rtd_theme

安装nginx

pkg install -y nginx

配置nginx

nginx配置文件路径/usr/local/etc/nginx
把网站根目录改成/usr/local/www/sphinx/biuld/html

vim /usr/local/etc/nginx/nginx.conf
location / {
    root   /usr/local/www/sphinx/build/html;
    index  index.html index.htm;

切换目录

cd /usr/local/www

创建目录

mkdir sphinx && cd sphinx

创建项目

sphinx-quickstart
欢迎使用 Sphinx 4.3.1 快速入门实用程序。

请输入以下设置的值(只需按 Enter 即可
接受默认值,如果在括号中给出)。

选定的根路径:.

您有两个选项可用于放置 Sphinx 输出的构建目录。
要么,您使用根路径中的目录“_build”,要么分开
根路径中的“source”和“build”目录。
> 分离源和构建目录 (y/n) [n]: y

项目名称将出现在构建文档中的多个位置。
> 项目名称:我的自传
> 作者姓名:暴徒
> 项目版本[]:v1.0

如果文件要用英语以外的其他语言编写,
您可以在此处通过语言代码选择一种语言。 然后狮身人面像
将它生成的文本翻译成该语言。

有关支持的代码列表,请参阅
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language。
> 项目语言 [en]: zh_CN

创建文件 /root/source/conf.py。
创建文件 /root/source/index.rst。
创建文件 /root/Makefile。
创建文件 /root/make.bat。

完成:已创建初始目录结构。

您现在应该填充您的主文件 /root/source/index.rst 并创建其他文档
源文件。 使用 Makefile 构建文档,如下所示:
制作建设者
其中“builder”是受支持的构建器之一,例如 html、乳胶或链接检查。

更改主题

把html_theme = 'alabaster' 改成html_theme = "sphinx_rtd_theme"

vim source/conf.py

生成html文件

sphinx-autobuild source build/html

访问sphinx

参见中科大:http://mirrors.ustc.edu.cn/help/
详细配置请参阅官方文档:https://www.sphinx-doc.org/zh_CN/master/usage/installation.html

最后修改:2022 年 07 月 02 日
赏点儿?