sphinx gives three warnings for overview.rst

未关闭
  • 哪里不对？
#658 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 7 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
50/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
documentation, python
领域
documentation

调研方向

The warnings come from ${region_start} and ${region_end} markers inside code-block:: python blocks in docs/overview.rst, at lines 403, 424 and 1268. Build with sphinx-build -M html docs _build to reproduce them. Done when the build no longer warns and the def keyword is highlighted, which means either making those examples lexable or changing how the markers are shown. The thread has no reply in about 3.6 years, so confirm with a maintainer before starting.

由索引模型根据 Issue 内容生成。

描述

bug 
> sphinx-build --version
sphinx-build 5.3.0
...
ekr-clone-rope2\docs> sphinx-build -M html . _build
...ekr-clone-rope2\docs\overview.rst:403: WARNING: Could not lex literal_block as "python". Highlighting skipped.
...ekr-clone-rope2\docs\overview.rst:424: WARNING: Could not lex literal_block as "python". Highlighting skipped.
...ekr-clone-rope2\docs\overview.rst:1268: WARNING: Could not lex literal_block as "python". Highlighting skipped.

The effect of the first warning is clearly visible on Rope's website. As you can see, the def keyword is not highlighted.

These warnings arise from the ${region_start} and ${region_end} markup. The first example is:

.. code-block:: python

  def a_func():
      a = 1
      b = 2 * a
      c = ${region_start}a * 2 + b * 3${region_end}

Heh. GitHub markdown renders this snippet correctly, but sphinx does not.

主要语言
Python
星标
2.2k
派生
197
平均合并
2 天 13 小时
30 天内合并 PR
5

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

python-rope/rope 的其他 Issue

查看 python-rope/rope 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。