использование автоиндекса необязательнов Boost. Создайте, чтобы пользователи, у которых нет AutoIndex, могли создавать вашу документацию.

Это также очень удобно, когда вы совершенствуете свою документацию, чтобы вы могли решить, строить индексы или нет: создание индексов может занять много времени, если вы просто исправляете опечатки, вам не захочется ждать, пока вы продолжаете восстанавливать индекс!

Одним из способов настройки опциональной поддержки AutoIndex является помещение всей конфигурации AutoIndex в корпус бьяма, если утверждение:

if --enable-index in  [ modules.peek : ARGV ]
  {
     ECHO "Building the  docs with automatic index generation enabled." ;
     using auto-index ;
     project : requirements
          <auto-index>on
          <auto-index-script>index.idx
           ... other AutoIndex options here...
        # And tell Quickbook that it should enable indexing.
        <quickbook-define>enable_index
    ;
  }
  else
  {
     ECHO "Building the my_library docs with automatic index generation disabled. To get an Index, try building with --enable-index." ;
  }

Вам также нужно будет добавить условное заявление в конце файла Quickbook, чтобы индекс (ы) был добавлен только после последнего раздела, если включена индексация.

[? enable_index
'''
  <index/>
'''
]

Чтобы использовать этот jamfile, вам нужно отобразить в папке docs, например:

cd \boost-sandbox\guild\mylibrary\libs\mylibrary\doc

а затем запустить<bjam>, чтобы построить документы без индекса, например:

bjam -a html > mylibrary_html.log

или с индексом(ами)

bjam -a html --enable-index > mylibrary_html_index.log