如何使用 Sphinx 在 Debian 服务器的子文件夹中加载文档
How to load up documentation with Sphinx on a subfolder of Debian server
我对 Sphinx 这边还很陌生。我已经在 Sphinx 官方文档站点上阅读了一些关于它的内容,并且我已经按照以下步骤在我的 Debian Wheezy 服务器上安装和配置它:
首先我在 http://example.com/documentation-path/.
上安装了 Sphinx 源
pip install sphinx
我已经执行了配置根目录的脚本sphinx-quickstart
和conf.py.
sphinx-quickstart
我已经执行了 make html
命令在我的目录路径中构建 HTML 个文件。
make html
我已经安装了 Sphinx autobuild for handle every
changes/updates 我的文档,写在 post made by @toast38coza.
pip install sphinx-autobuild
sphinx-autobuild source build/html
[我已经解决的问题]
我的第一个问题是我无法正确查看文档索引模板,因为服务器开始在 http://127.0.0.1:8000(本地主机端口 8000)上监视文档文件的更改。因此,当我在当前 PC 上本地安装它时,我得到了相同的 url 路径。正如我在本地版本测试中所说,它运行良好。
因为我正在搜索类似 URL 路径配置 (http://example.com) 的东西,所以我决定将参数添加为 -host 和 -port 以让它在 Debian 上正常工作:
-p/--port option to specify the port on which the documentation shall be served (default 8000)
-H/--host option to specify the host on which the documentation shall be served (default 127.0.0.1)
然后我配置了它,启动它并且运行良好:
>> sphinx-autobuild source build/html --host http://example.com --port8000
所以现在如果我冲浪 http://example.com:8000
我获得了文档索引模板的正确视图。
[我的主要问题]
即使考虑到 Sphinx 安装的根路径是 /documentation-path/,如何在不同的 URL 路径(例如像 http://example.com/documentation-path/ 的子文件夹中启动此视图?
[我的第二个问题]
如何在 Debian 控制台上每次使用 --port 和 --host 指令 sphinx-autobuild
时都编写可视化模板视图的过程?
[重要通知]
此刻 Debian 服务器配置了 NGINX,这对我来说是全新的。
终于在NGINX documentation的帮助下自己解决了子文件夹路径问题。
location /documentation {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_pass http://localhost:8000;
index index.php index.html index.htm;
}
关于自动加载问题,我刚刚从 Sphinx 切换到 Markdown,之后我使用 couscousPHP 生成来自降价文档的 GitHub 页网站。
这对我来说是提供静态 html 文件而无需每次从 ssh 控制台获取源时自动加载的更聪明的方法。事实上,我可以轻松地从 .md 文件中输入命令 couscous generate
.
生成我的转换 html 文件
我对 Sphinx 这边还很陌生。我已经在 Sphinx 官方文档站点上阅读了一些关于它的内容,并且我已经按照以下步骤在我的 Debian Wheezy 服务器上安装和配置它:
首先我在 http://example.com/documentation-path/.
上安装了 Sphinx 源pip install sphinx
我已经执行了配置根目录的脚本
sphinx-quickstart
和conf.py.sphinx-quickstart
我已经执行了
make html
命令在我的目录路径中构建 HTML 个文件。make html
我已经安装了 Sphinx autobuild for handle every changes/updates 我的文档,写在 post made by @toast38coza.
pip install sphinx-autobuild
sphinx-autobuild source build/html
[我已经解决的问题]
我的第一个问题是我无法正确查看文档索引模板,因为服务器开始在 http://127.0.0.1:8000(本地主机端口 8000)上监视文档文件的更改。因此,当我在当前 PC 上本地安装它时,我得到了相同的 url 路径。正如我在本地版本测试中所说,它运行良好。
因为我正在搜索类似 URL 路径配置 (http://example.com) 的东西,所以我决定将参数添加为 -host 和 -port 以让它在 Debian 上正常工作:
-p/--port option to specify the port on which the documentation shall be served (default 8000) -H/--host option to specify the host on which the documentation shall be served (default 127.0.0.1)
然后我配置了它,启动它并且运行良好:
>> sphinx-autobuild source build/html --host http://example.com --port8000
所以现在如果我冲浪 http://example.com:8000 我获得了文档索引模板的正确视图。
[我的主要问题]
即使考虑到 Sphinx 安装的根路径是 /documentation-path/,如何在不同的 URL 路径(例如像 http://example.com/documentation-path/ 的子文件夹中启动此视图?
[我的第二个问题]
如何在 Debian 控制台上每次使用 --port 和 --host 指令 sphinx-autobuild
时都编写可视化模板视图的过程?
[重要通知]
此刻 Debian 服务器配置了 NGINX,这对我来说是全新的。
终于在NGINX documentation的帮助下自己解决了子文件夹路径问题。
location /documentation {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_pass http://localhost:8000;
index index.php index.html index.htm;
}
关于自动加载问题,我刚刚从 Sphinx 切换到 Markdown,之后我使用 couscousPHP 生成来自降价文档的 GitHub 页网站。
这对我来说是提供静态 html 文件而无需每次从 ssh 控制台获取源时自动加载的更聪明的方法。事实上,我可以轻松地从 .md 文件中输入命令 couscous generate
.