Глобальное включение в реструктурированный текст

Я не совсем уверен, понимаю ли я вопрос. Вы хотите определить ряд, например, замен в каком-то файле и сделать их доступными во всех других ваших файлах reStructuredText, или вы хотите включить некоторый общий HTML в свои выходные файлы? Можете уточнить свой вопрос?

Если вы хотите сделать первое, вы можете использовать include< /a>, как я описал в этом ответе.

В качестве альтернативы, если вы хотите, чтобы в сгенерированный вывод был включен некоторый общий HTML, попробуйте скопировать и отредактировать файл template.txt, который включен в модуль path/to/docutils/writers/html4css1/. В этот файл можно включать произвольные элементы HTML и изменять макет HTML, сгенерированный Docutils. Ни один из этих методов не требует изменения исходного кода Docuitls, что всегда является преимуществом.

Изменить: я не думаю, что можно установить флаг для установки включаемого файла с помощью Docuitls. Однако, если вы можете использовать Sphinx, который основан на Docuitls, но имеет множество расширений, то этот пакет имеет параметр rst_prolog, который делает именно то, что вам нужно (см. < href="https://stackoverflow.com/a/9707879/623518">этот ответ). rst_prolog это:

Строка reStructuredText, которая будет включена в начало каждого считываемого исходного файла.

Мне нужно было то же самое: способ автоматического импорта некоторых глобальных файлов reStructuredText в каждую статью reStructuredText без необходимости указывать их каждый раз вручную.

Одним из решений этой проблемы является следующий плагин:

import os
from pelican import signals
from pelican.readers import RstReader


class RstReaderWrapper(RstReader):
      enabled = RstReader.enabled
      file_extensions = ['rst']

      class FileInput(RstReader.FileInput):
          def __init__(self, *args, **kwargs):
              RstReader.FileInput_.__init__(self, *args, **kwargs)
              self.source = RstReaderWrapper.SourceWrapper(self.source)

      # Hook into RstReader
      RstReader.FileInput_ = RstReader.FileInput
      RstReader.FileInput = FileInput

      class SourceWrapper():
          """
              Mimics and wraps the result of a call to `open`
          """
          content_to_prepend = None

          def __init__(self, source):
              self.source = source

          def read(self):
              content = self.source.read()
              if self.content_to_prepend is not None:
                  content = "{}\n{}".format(self.content_to_prepend, content)
              return content

          def close(self):
              self.source.close()


def process_settings(pelicanobj):
      include_files = pelicanobj.settings.get('RST_GLOBAL_INCLUDES', []) or []
      base_path = pelicanobj.settings.get('PATH', ".")

      def read(fn):
          with open(os.path.join(base_path, fn), 'r') as res:
              content = res.read()
              return ".. INLCUSION FROM {}\n{}\n".format(fn, content)

      inclusion = "".join(map(read, include_files)) if include_files else None
      RstReaderWrapper.SourceWrapper.content_to_prepend = inclusion


def register():
signals.initialized.connect(process_settings)

Коротко об использовании:

• Создайте плагин из приведенного выше кода (лучше всего клонировать репозиторий с GitHub)
• Импортируйте плагин (адаптируйте PLUGINS в pelicanconf.py)
• Определите список файлов RST (относительные пути к корню проекта) для включения, установив переменную RST_GLOBAL_INCLUDES в pelicanconf.py.

Обратите внимание, что pelican и docutils не предназначены для этого. Не предоставляется ни сигнал, который обеспечивает чистый доступ к необработанному содержимому исходного файла до начала обработки, ни возможность перехватить фреймворк, читающий файл «обычным способом» (например, создание подклассов, изменение жестко закодированной конфигурации и т. д.) . Этот подключаемый модуль создает подкласс внутреннего класса FileInput из RstReader и устанавливает ссылку на класс из RstReader.FileInput в подкласс. Также файловые объекты python эмулируются через SourceWrapper. Тем не менее, этот подход работает для меня и не является громоздким в ежедневном рабочем процессе.

Я знаю, что этот вопрос задан в 2012 году, но я думаю, что этот ответ может быть полезен другим.