How to Generate PCL Documents and Tutorials

Docs.md

How to Generate PCL Documents and Tutorials

Download

• Dependents for Generate PCL Documents and Tutorials

Dependents

1. 依存ツールをインストールする。
   WITH_DOCS

   • Doxygen

     1. Doxygen(doxygen-1.8.14-setup.exe)をダウンロード、インストールする。
        https://sourceforge.net/projects/doxygen/
        https://sourceforge.net/projects/doxygen/files/rel-1.8.14/

     2. 環境変数PATHに以下のパスを設定する。
        C:\Program Files\doxygen\bin

   • LaTeX

     1. MiKTeX(basic-miktex-22.10-x64.exe)をダウンロード、インストールする。
        http://www.miktex.org/download

     2. 環境変数PATHに以下のパスを設定する。
        C:\Program Files\MiKTeX\miktex\bin\x64

   • Ghostscript

     1. Ghostscript(gs910w32.exe)をダウンロード、インストールする。
        https://sourceforge.net/projects/ghostscript/
        https://code.google.com/archive/p/ghostscript/downloads

     2. 環境変数PATHに以下のパスを設定する。
        C:\Program Files (x86)\gs\gs9.10\bin

   • HTML Help

     1. Microsoft HTML Help Workshop(htmlhelp.exe)をダウンロードする。
        https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985.aspx
        https://www.helpandmanual.com/downloads_mscomp.html

     2. 管理者権限で自己解凍形式の圧縮ファイルを解凍する。

   • Graphviz

     1. Graphviz(graphviz-2.38.msi)をダウンロード、インストールする。
        http://graphviz.org/Download.php
        https://www2.graphviz.org/Archive/stable/windows/

     2. 環境変数PATHに以下のパスを設定する。
        C:\Program Files (x86)\Graphviz2.38\bin

   WITH_TUTORIALS

   • Python

     1. Python 2.7.13(python-2.7.13.msi)をダウンロード、インストールする。
        https://www.python.org/

     2. 環境変数PATHに以下のパスを設定する。
        C:\Python27
        C:\Python27\Scripts

   • Sphinx

     1. コマンドプロンプトを開き、以下のコマンドを実行してインストールする。

        pip install sphinx
        

   • sphinxcontrib-doxylink

     1. コマンドプロンプトを開き、以下のコマンドを実行してインストールする。

        pip install sphinxcontrib-doxylink==1.3
        

   • sphinx_rtd_theme

     1. コマンドプロンプトを開き、以下のコマンドを実行してインストールする。

        pip install sphinx_rtd_theme==0.4.3
        

   • pyparsing

     1. コマンドプロンプトを開き、以下のコマンドを実行してインストールする

        pip install pyparsing==2.1.9
        

CMake

3. 各種設定を行う。
   (GroupedとAdvancedにチェックを入れるとわかりやすい。)
   Ungrouped Entries

   • PYTHON_EXECUTABLE C:/Python27/python.exe

   DOXYGEN

   • DOXYGEN_DOT_EXECUTABLE C:/Program Files (x86)/Graphviz2.38/bin/dot.exe
   • DOXYGEN_EXECUTABLE C:/Program Files/doxygen/bin/doxygen.exe
   • DOXYGEN_USE_SHORT_NAMES ☐(uncheck)

   HTML

   • HTML_HELP_COMPILER C:/Program Files (x86)/HTML Help Workshop/hhc.exe
   • HTML_HELP_INCLUDE_PATH C:/Program Files (x86)/HTML Help Workshop/include
   • HTML_HELP_LIBRARY C:/Program Files (x86)/HTML Help Workshop/lib/htmlhelp.lib

   SPHINX

   • SPHINX_EXECUTABLE C:/Python27/Scripts/sphinx-build.exe
   • SPHINX_HTML_FILE_SUFFIX html

   WITH

   • WITH_DOCS ☑(check)
   • WITH_TUTORIALS ☑(check)

4. 設定内容を確認する。

   • DOXYGEN_FOUND YES
   • HTML_HELP_COMPILER C:/Program Files (x86)/HTML Help Workshop/hhc.exe

Note

• Doxygenは最新バージョンではエラーになるので1.8.14を使う。
• Ghostscriptは最新バージョンではエラーになるので9.10の32bitを使う。
• Pythonは64bitでも大丈夫。
• Python3ではadvancedプロジェクトがビルドできない。