documentation – ¿Cómo eliminar "ver" de los enlaces de información / referencias cruzadas?

Pregunta:

Estoy generando documentación de Django para hacer referencia a ella más fácilmente en Emacs. El enfoque obvio [^] da como resultado referencias cruzadas con "ver" antepuesto. Por ejemplo, la documentación en línea para las instancias modelo dice:

Este documento describe los detalles del modelo API. Se basa en el material presentado en las guías de consulta del modelo y la base de datos , por lo que probablemente desee leer y comprender esos documentos antes de leer este.

mientras que abrir el texinfo en Info da como resultado:

Este documento describe los detalles de la API 'Modelo'. Se basa en el material presentado en la sede del modelo y vea consulta de base de datos . guías, por lo que probablemente querrá leer y comprender esos documentos antes de leer este.

¿Cómo puedo deshacerme de este "ver"?


[^]: El enfoque obvio es:

git clone https://github.com/django/django.git
cd django && git checkout stable/1.11.x
cd docs && make texinfo
cd _build/texinfo && sudo make install-info

Respuesta:

Estaba buscando la variable Info-hide-note-references . Específicamente, configurarlo en 'hide da como resultado el comportamiento que quiero. Las Preguntas frecuentes de Sphinx dan más detalles sobre esto y sugieren los siguientes consejos para habilitarlo automáticamente en archivos generados por Sphinx (se corrigió ya que la expresión regular que sugieren no funcionaba)

(defvar-local Info-hide-note-references t)

(defun fov-auto-hide-info-note-references (&rest _args)
  "Advice to automatically hide 'see' in info files generated by sphinx."
  ;; Adapted from http://www.sphinx-doc.org/en/stable/faq.html#displaying-links
  (save-excursion
    (save-restriction
      (widen)
      (goto-char (point-min))
      (when (re-search-forward
             "^ *Generated by \\(Sphinx\\|Docutils\\)"
             (save-excursion (search-forward "\x1f" nil t)) t)
        (setq Info-hide-note-references 'hide)))))

(advice-add 'info-insert-file-contents :after #'fov-auto-hide-info-note-references)

Leave a Comment

Your email address will not be published. Required fields are marked *

Scroll to Top

web tasarım