embARC Documentation Generation

Building Document in Windows

  • Install Sphinx in the Windows machine.

    >sphinx-build --version
    Sphinx (sphinx-build) 1.6.3
    
  • Install Doxygen in the Windows machine.

    >doxygen --version
    1.8.13
    
  • Open a command prompt as administrator. Go to <embARC>/doc/documents/example. Enter mklink /D example ..\..\..\example to create a folder link to <embARC>/example.

    >mklink /D example ..\..\..\example
    symbolic link created for example <<===>> ..\..\..\example
    
  • If Cannot create a file when that file already exists., it means you have already have a file or folder example. Make sure the link is accessible to <embARC>/example.

    >mklink /D example ..\..\..\example
    Cannot create a file when that file already exists.
    
  • Go to <embARC>/doc and generate xml files by Doxygen.

    >mkdir build\doxygen\xml
    >make doxygen
    
  • Go to <embARC>/doc and enter make html to generate html. The html files are in <embARC>/doc/build/html.

    >make html
    

Note

Enter make in <embARC>/doc to see the details of make target.