sphinx gives three warnings for overview.rst

Aperta
  • Qualcosa non va?
#658 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 7 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
50/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
documentation, python
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
2.2k
Fork
197
Merge medio
2g 13h
PR unite (30g)
5

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di python-rope/rope

Tutte le issue di python-rope/rope

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.