Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Can we speed up sandcastle?

Tags:

We make use of sandcastle (and SHFB) to generate class library documentation from inline XML comments. It's a great tool to maintain complete and professional looking reference + overview documentation, including correct code samples.

Unfortunately, it's also dog slow. It's by far the most time consuming step of our automated build, and it's starting to hurt. Is there any way to speed it up?

like image 929
Wim Coenen Avatar asked Mar 03 '09 00:03

Wim Coenen


2 Answers

If you have SdkLinkType=Msdn (see properties of your SHFB project) sandcastle connects to MSDN documentation using web service. That may slooowww build down in case of connection troubles. You may try to set SdkLinkType=None to turn off building MSDN links (in that case you will not have links to MSDN in your help). In my case that improved my build time 5 times (2 minutes instead of 10 minutes).

like image 51
Vladimir Datsyuk Avatar answered Sep 23 '22 02:09

Vladimir Datsyuk


The discussion group over at CodePlex is pretty active and knowledgable. Here's a semi on topic post (no help though): http://sandcastle.codeplex.com/Thread/View.aspx?ThreadId=32267

like image 23
user53794 Avatar answered Sep 22 '22 02:09

user53794