Использование sphinx для создания контекстно-зависимой HTML-справки - PullRequest
3 голосов
/ 22 апреля 2010

В настоящее время я использую AsciiDoc (http://www.methods.co.nz/asciidoc/) для документирования своих программных проектов, поскольку он поддерживает создание справки в формате pdf и html. В настоящее время я запускаю его через cygwin, чтобы цепочка инструментов a2x функционировала правильно. Это хорошо работает для меня но это плохо для установки на других компьютерах с Windows. Я искал альтернативные методы и недавно пересмотрел Sphinx. Заметив, что теперь он генерирует html-файлы справки, я попробовал, и, похоже, он хорошо работает в небольших тестах, которые я выполнял.

У меня вопрос, есть ли способ указать идентификаторы карты для контекстно-зависимой справки в тексте, чтобы мои программы Windows могли вызывать надлежащий api справки, а файл запускался и открывался в нужном месте?

В AsciiDoc я использую "pass :: []". Используя эти конструкции, создаются context.h и alias.h вместе с другими html-файлами справки ( информация о контекстно-зависимой справке ).

1 Ответ

1 голос
/ 23 апреля 2010

Я мало что знаю об AcsiiDoc, но в Sphinx вы можете ссылаться на произвольные места, размещая якоря там, где они вам нужны. http://sphinx.pocoo.org/markup/inline.html#ref-role

...