程序员经验分享-hwhale

在 ReadTheDocs 上使用自定义主题

2023-12-21

我尝试使用从 Sphinx 的内置 ReadTheDocs 主题继承的自定义主题。

当我在本地计算机上使用它时，我有很好的设计。但是当我阅读文档版本（从 gi​​thub 导入）时，没有 CSS。

我错过了什么？

使用自定义主题的分支的存储库：https://github.com/DigitalSkills-fr/Docs/tree/custom_theme/docs https://github.com/DigitalSkills-fr/Docs/tree/custom_theme/docs

目标分支的 RTD 文档：http://digitalskills-docs.readthedocs.io/fr/custom_theme/index.html http://digitalskills-docs.readthedocs.io/fr/custom_theme/index.html


您应该仅在您的文件中指定内置主题名称conf.py https://github.com/DigitalSkills-fr/Docs/blob/custom_theme/docs/conf.py#L107.

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#html_theme = 'default'
html_theme = 'theme_digitalskills'

删除您的自定义条目并将原始条目恢复为：

html_theme = 'default'

假设您已经修改了分支中的 CSS 文件custom_theme，那么 RTD 应复制指定目录列表中的所有文件html_static_path，覆盖内置主题的 CSS 文件：

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

pythonsphinx

ReadTheDocs

在 ReadTheDocs 上使用自定义主题 的相关文章

  • 在 Python Sphinx 中使用 automodule 不显示变量和类属性

    我想知道为什么在 Sphinx 中使用 automodule 指令时我无法看到类属性 即使属性有文档字符串 与 Django 设置常量相同 它们没有显示 I use automodule settings members show inhe

  • python的sphinx中var、cvar和ivar有什么区别？

    我正在阅读 sphinx 文档页面 讽刺的是发现关于 var ivar 和 cvar 之间差异的文档非常缺乏 我想知道是否有人可以解释内联代码中每个不同名称空间之间的区别 Example class foo object var str f

  • 使用“from x import *”记录文件

    sphinx 的 automodule 和其他自动功能可用于记录包含以下内容的模块from x import 声明不包含导入模块的所有文档 编辑 根据mzjn的观点 只要导入的方法 module 属性与模块名称不同 不应记录它们 然而 对于

  • 在 Sphinx 中的文件链接中使用版本号

    在 Sphinx 中 可以使用以下语法生成文件链接 name of file js

  • 在 readthedocs 中构建随机失败

    Readthedocs 似乎有一个奇怪的问题 构建失败 没有任何明显的原因 在同一个提交 ID 上 构建一次失败 后来成功 Failure https readthedocs org projects opnfvdocsdemo build

  • 在 Python Sphinx 生成的文档中包含动态内容

    我正在使用 Sphinx 为我的项目生成文档 并在产品安装过程中构建文档 我想在文本和 或代码块中动态包含主机名 我没有在文档中看到任何解释 也没有看到任何包含 shell 命令输出或特定文件中特定行以外的任何内容的工具 有这个功能吗 这里

  • RestructedText - 向链接添加标题属性

    我正在尝试在我的网站上使用从 reStructuredText 生成的 jQuery lightBox 实现 lightBox 将图像周围的链接标题作为 lightBox 显示中图像的标题 但是 我似乎无法在 reStructuredTex

  • 如何使 Sphinx 尊重使用 __init__.py 将类导入到包中

    我有一个包裹 foo foo py bar py init py foo py 有一个 Foo 类 在 init py 中 我导入了 Foo 类 以便用户可以执行以下操作 from foo import Foo Sphinx 正确地将 Fo

  • 通过序言格式化 csv 表？

    尽我所能 我无法弄清楚如何更改 sphinx 的 pdf 输出中的默认表格格式 我可以编辑 tex 文件或 writer py 源代码 但这两个似乎都是不好的选择 有什么东西可以通过序言来实现这一点吗 取决于您试图通过更改表格格式来完成的任

  • 如何在 Windows 中使用 Sphinx 创建 PDF 文档

    我正在使用 Sphinx 在 Windows 中为我的 Python 项目创建文档 我需要生成 PDF 文档 我发现了很多关于如何在 Linux 中执行此操作的解释 但没有很好的解释如何在 Windows 中执行此操作 据我了解 我需要使用

  • Sphinx：autodoc 无法导入模块

    我对狮身人面像有以下问题 我的项目结构是 project api init py rpc py v1 init py model py build source conf py Makefile 在conf py中我有 import os

  • 阅读文档构建失败，并显示“无法从‘pip._internal.index’导入名称‘PackageFinder’”

    在阅读文档时构建 Sphinx 文档失败 并出现以下错误 完整日志如下 ImportError cannot import name PackageFinder from pip internal index home docs check

  • 使 viewcode 显示模块源

    我正在尝试使用 Sphinx 用一些 Python 片段制作一本食谱 每个片段都是一个独立的 Python 脚本 并且有一个教程类型的文档 我希望在生成的文档中有一个源链接来显示脚本内容 但viewcode https www sphinx

  • 如何将主页包含在 Sphinx 目录中？

    假设我有一个 Sphinx 项目 其来源如下 index rst installation rst templating index rst module rst fieldtype rst index rst 主页 具有以下目录树 toc

  • 摆脱 Sphinx 中的“重复标签”警告

    在 Sphinx 中 我收到大量警告 例如 PATH FILENAME LINE WARNING duplicate label LABELNAME other instance in PATH FILENAME 似乎将所有节标题视为 标签

  • 在 Sphinx 中的引用中保留内联代码

    在 Sphinx 中 如果我有以下标题声明 somestuff this is code this is not 它呈现如下 this is code 这不是 这很好 但是 如果我使用参考 例如 Have a look at ref som

  • 如何处理 ReST 中的两个破折号

    我正在使用 Sphinx 来记录用 Python 编写的命令行实用程序 我希望能够记录命令行选项 例如 region像这样 region

  • 用于将一个文档包含到另一个文档中的 sphinx 指令是什么？

    在我的文档中我有一个examples我可以说的目录 literalinclude examples 1 basic usage py language python linenos 效果很好 因为它们是代码 并且它们的格式正确为代码 但是

  • readthedocs 中自动生成的索引文件

    我无法上传到阅读文档 http docs readthedocs io en latest 我为我的项目准备的文档 我正在尝试了解问题所在 该文档在本地构建良好make html但我无法上传 GitHub 项目是ASCII基因组 https

  • Mathworks 生成 Matlab HTML 文档的方法是什么？

    我正在开发共享的 Matlab 代码 我们希望在本地网络中将生成的文档作为可搜索的 HTML 文档共享 我知道以下生成文档的方法 编写一个类似于 C 文件的转换器 这是在中完成的将 Doxygen 与 Matlab 结合使用 http ww

随机推荐

热门标签