Catkin document appears to crash on summary:summary_sphinx

[Ishadijcks]

I was trying to run catkin_document, but it appears to crash when sphinx wants to generate a summary.

I've tried to run with --no-summary as a workaround, but it produces the same error.

Do you have any idea how I can fix it?

$ catkin document
[build] Found '12' packages in 0.0 seconds.                                                                                                                                                                                                                    
Starting  >>> package1
...                                                                                                                                                                                                                                
Starting  >>> package12                                                                                                                                                                                                    
Finished  <<< package1                                             [ 0.0 seconds ]
...                                                                                                                                                                         
Finished  <<< package12                                      [ 1.2 seconds ]                                                                                                                                                                         

Starting  >>> summary                                                                                                                                                                                                                                          
_______________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
Errors     << summary:summary_sphinx logs/summary/document.summary_sphinx.008.log                                                                                                                                           

Exception occurred:
  File "/usr/lib/python2.7/dist-packages/sphinx/util/parallel.py", line 99, in _join_one
    raise SphinxParallelError(*result)
SphinxParallelError: InputError: [Errno 2] No such file or directory: u'/<directory>/docs/actionlib/CHANGELOG.rst'
The full traceback has been saved in /tmp/sphinx-err-Pupaeg.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
cd /home/ishadijcks/march-iv/march_ws/build/docs; catkin document --get-env summary | catkin env -si  /usr/bin/sphinx-build -j8 -E . /<directory>/march-iv/march_ws/build/../docs; cd -
...............................................................................................................................................................................................................................................................
Failed     << summary:summary_sphinx                                   [ Exited with code 1 ]                                                                                                                                                                  
Failed    <<< summary                                                  [ 0.5 seconds ]                                                                                                                                                                         
[document] Summary: 12 of 13 packages succeeded.                                                                                                                                                                                                               
[document]   Ignored:   None.                                                                                                                                                                                                                                  
[document]   Warnings:  None.                                                                                                                                                                                                                                  
[document]   Abandoned: None.                                                                                                                                                                                                                                  
[document]   Failed:    1 packages failed.                                                                                                                                                                                                                     
[document] Runtime: 4.5 seconds total.         

[mikepurvis]

Hi! This is curious— the logic here is supposed to only link a CHANGELOG.rst file if it exists in a given package:

https://github.com/mikepurvis/catkin_tools_document/blob/fb0cc3e37a2f70658bd46305e2a1097c5da1fb30/catkin_tools_document/messages.py#L160-L166

If you comment out that highlighted block, does it then work? Alternatively, do you mind posting the contents of package1 and package12 somewhere so I can reproduce the problem?

[Ishadijcks]

The same still happens unfortunately. (I have confirmed the code running was changed by adding some prints) The main repository is located here. You'd have to clone it recursively as it contains submodules. All branches on develop and the march-iv repo on feature/readthedocs

I'm also curious as to why running with --no-summarize still tries to add an extra summary package.

If you need any more information let me know!

Edit: When navigating to the file it says is missing, I get the following warning: "The link 'CHANGELOG.rst" is broken. Move it to Trash?

[Ishadijcks]

I have removed my build/ and devel/ folders and ran catkin_make again. Now catkin document runs without failure! I'm not completely sure what the issue was, but it appears to be fixed.

Feel free to close this issue.