Assembla home | Assembla project page
 

Ticket #114 (closed defect: fixed)

Opened 3 months ago

Last modified 2 months ago

documentation fails to build on windows with spaces in file names

Reported by: trvsst Assigned to: joaander
Priority: normal Milestone: 0.8.0
Component: Documentation (Developer) Keywords:
Cc:

Description

This is the two compiler error obtained in compiling windows

Generating html/index.html

Generating html/index.html Warning: tag INPUT: input source `C:/Documents' does not exist Warning: tag INPUT: input source `and' does not exist Warning: tag INPUT: input source `Settings/Alex/FUNCTIONS/Research/HOOMD/src' does not exist Warning: tag INPUT: input source `C:/Documents' does not exist Warning: tag INPUT: input source `and' does not exist Warning: tag INPUT: input source `Settings/Alex/FUNCTIONS/Research/HOOMD/src/user_doc/prereq_install.doc' does not exist Warning: tag INPUT: input source `C:/Documents' does not exist Warning: tag INPUT: input source `and' does not exist Warning: tag INPUT: input source `Settings/Alex/FUNCTIONS/Research/HOOMD/src/user_doc/compile_guide.doc' does not exist Warning: tag INPUT: input source `C:/Documents' does not exist Warning: tag INPUT: input source `and' does not exist Warning: tag INPUT: input source `Settings/Alex/FUNCTIONS/Research/HOOMD/src/user_doc/credits.doc' does not exist Warning: tag INPUT: input source `C:/Documents' does not exist Warning: tag INPUT: input source `and' does not exist Warning: tag INPUT: input source `Settings/Alex/FUNCTIONS/Research/HOOMD/src/user_doc/license.doc' does not exist Warning: tag INPUT: input source `C:/Documents' does not exist Warning: tag INPUT: input source `and' does not exist Warning: tag INPUT: input source `Settings/Alex/FUNCTIONS/Research/HOOMD/src/doc/DeveloperInfo.doc' does not exist Warning: tag INPUT: input source `C:/Documents' does not exist Warning: tag INPUT: input source `and' does not exist Warning: tag INPUT: input source `Settings/Alex/FUNCTIONS/Research/HOOMD/src/doc/Groups.doc' does not exist Warning: tag INPUT: input source `C:/Documents' does not exist Warning: tag INPUT: input source `and' does not exist Warning: tag INPUT: input source `Settings/Alex/FUNCTIONS/Research/HOOMD/src/doc/MainPage.doc' does not exist Error: tag OUTPUT_DIRECTORY: Output directory `C:/DocumentsandSettings/Alex/FUNCTIONS/Research/HOOMD/msvc/doc/' does not exist and cannot be created Project : error PRJ0019: A tool returned an error code from "Generating html/index.html" Build log was saved at "file://c:\Documents and Settings\Alex\FUNCTIONS\Research\HOOMD\msvc\doc\doc.dir\Debug\BuildLog?.htm" doc - 1 error(s), 0 warning(s)

Generating html/index.html Error: tag HTML_HEADER: header file `C:/DocumentsandSettings/Alex/FUNCTIONS/Research/HOOMD/src/user_doc/header.html' does not exist Project : error PRJ0019: A tool returned an error code from "Generating html/index.html" Build log was saved at "file://c:\Documents and Settings\Alex\FUNCTIONS\Research\HOOMD\msvc\user_doc\user_doc.dir\Debug\BuildLog?.htm" user_doc - 1 error(s), 0 warning(s)

Error: tag HTML_HEADER: header file `C:/DocumentsandSettings/Alex/FUNCTIONS/Research/HOOMD/src/user_doc/header.html' does not exist Project : error PRJ0019: A tool returned an error code from "Generating html/index.html" Build log was saved at "file://c:\Documents and Settings\Alex\FUNCTIONS\Research\HOOMD\msvc\user_doc\user_doc.dir\Debug\BuildLog?.htm" user_doc - 1 error(s), 0 warning(s)

Attachments

Change History

08/12/08 22:25:32 changed by joaander

  • owner changed from jooander to joaander.
  • status changed from new to assigned.
  • summary changed from compiling errors in unit test to documentation fails to build on windows with spaces in file names.

This isn't a unit test problem. doxygen appears to be failing to build the documentation because of spaces in the file names. I never noticed because my hoomd checkout is in a directory with no spaces in it.

I've added quotes around paths in r , this fixes the problem in my tests.

Make sure you have the latest version of doxygen (1.5.6) or you may get more errors. I'm not using some features that were added in that version.

The following warnings are normal for user_doc 

E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/analyze.py:113: Warning: parameters of member hoomd_script::analyze::_analyzer::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/analyze.py:138: Warning: parameters of member hoomd_script::analyze::_analyzer::enable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/analyze.py:113: Warning: parameters of member hoomd_script::analyze::_analyzer::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/analyze.py:138: Warning: parameters of member hoomd_script::analyze::_analyzer::enable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/bond.py:72: Warning: parameters of member hoomd_script::bond::harmonic::__init__ are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/force.py:108: Warning: parameters of member hoomd_script::force::_force::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/force.py:133: Warning: parameters of member hoomd_script::force::_force::enable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/analyze.py:113: Warning: parameters of member hoomd_script::analyze::_analyzer::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/analyze.py:138: Warning: parameters of member hoomd_script::analyze::_analyzer::enable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/analyze.py:113: Warning: parameters of member hoomd_script::analyze::_analyzer::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/force.py:108: Warning: parameters of member hoomd_script::force::_force::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/force.py:133: Warning: parameters of member hoomd_script::force::_force::enable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/force.py:108: Warning: parameters of member hoomd_script::force::_force::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/force.py:133: Warning: parameters of member hoomd_script::force::_force::enable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/update.py:215: Warning: parameters of member hoomd_script::update::sort::__init__ are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/update.py:111: Warning: parameters of member hoomd_script::update::_updater::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/update.py:136: Warning: parameters of member hoomd_script::update::_updater::enable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/update.py:111: Warning: parameters of member hoomd_script::update::_updater::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/update.py:136: Warning: parameters of member hoomd_script::update::_updater::enable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/force.py:108: Warning: parameters of member hoomd_script::force::_force::disable are not (all) documented
E:/Documents and Settings/joaander/Desktop/hoomd/src/lib/python-module/hoomd_script/force.py:133: Warning: parameters of member hoomd_script::force::_force::enable are not (all) documented

They are because of a bug in doxygen.

There are also numerous warnings when the doc target is built. These are because I haven't taken the time to update the docs of everything yet: #14

One more thing to check is if the latex forumulas are processed correctly on windows. My windows install doesn't have latex so I can't test this at the moment.

08/12/08 22:27:11 changed by joaander

I meant to say that the quotes are added in r1167

09/04/08 15:20:56 changed by joaander

Alex, have you checked if the latex forumals correctly generate in the documentation on your windows box? I'd like to close this ticket.

09/06/08 00:43:05 changed by joaander

  • status changed from assigned to closed.
  • resolution set to fixed.

Nevermind. I spent all afternoon downloading Latex so I could verify that it worked.

Add/Change #114 (documentation fails to build on windows with spaces in file names)




Action