doxygen.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Mon, 09 Oct 2017 10:49:36 +0300
changeset 2188 e95731eef030
parent 1912 8b81a8f0f692
permissions -rw-r--r--
Fixed: NameError: name 'locale_encoding' is not defined File /bin/rst2html.py, line 17, in <module> from docutils.core import publish_cmdline, default_description File /usr/lib/python2.7/site-packages/docutils/core.py, line 20, in <module> from docutils import frontend, io, utils, readers, writers File /usr/lib/python2.7/site-packages/docutils/frontend.py, line 41, in <module> import docutils.utils File /usr/lib/python2.7/site-packages/docutils/utils/__init__.py, line 20, in <module> import docutils.io File /usr/lib/python2.7/site-packages/docutils/io.py, line 18, in <module> from docutils.utils.error_reporting import locale_encoding, ErrorString, ErrorOutput File /usr/lib/python2.7/site-packages/docutils/utils/error_reporting.py, line 60, in <module> codecs.lookup(locale_encoding or '') # None -> '' NameError: name 'locale_encoding' is not defined

.. -*- coding: utf-8; -*-

==========
 Doxygen.
==========
.. contents::
   :local:

Installing.
===========
::

  $ sudo apt-get install doxygen
  $ sudo apt-get install doxygen-gui

Graphical wizard called as::

  $ doxywizard

Doxygen simple workflow.
========================
::

  $ cd $proj
  $ doxygen -g $proj.cfg  # generate basic config file

Edit $proj.cfg. Some essential settings::

  PROJECT_NAME     = my-proj
  OUTPUT_DIRECTORY = my
  OUTPUT_LANGUAGE  = English
  INPUT            = my.h my.hpp dir/
  INPUT_ENCODING   = UTF-8
  FILE_PATTERNS    =
  RECURSIVE        = NO
  GENERATE_HTML    = YES

Generate .chm from doxygen.
===========================

Check doxygen config file for::

  GENERATE_HTMLHELP  = YES
  CHM_FILE           = my.chm
  CHM_INDEX_ENCODING = Windows-1251

Run 'doxygen' and 'hhc.exe' on generated 'index.hhp'::

  $ doxygen $proj.cfg
  $ cd $proj/html     # here gone doxygen html output
  $ hhc.exe index.hhp