Unable to build the doc #346

lionpeloux · 2015-10-18T10:50:39Z

Hello,

I've tried to build the doc (running build.sh DocsWatch or build.sh DocsDev) but get into troubles (see error report bellow).

Do you have any thoughts how to bypass this ?

Thank you,
Lionel

System : mac OSX 10.10.5 - mono 4.0.4 - xamarin studio

     132 Warning(s)
     0 Error(s)

Time Elapsed 00:00:28.5451170
Finished Target: BuildMain
Starting Target: Build (==> BuildMain)
Finished Target: Build
Starting Target: CleanDocs (==> Start, Build)
Deleting contents of out/docs
Finished Target: CleanDocs
Starting Target: DocsDev (==> CleanDocs)
fsharpi build-docs.fsx
FSharp.Formatting Information: 0 : FSharp.Formatting Logging setup!
Yaaf.FSharp.Scriping Information: 0 : Yaaf.FSharp.Scripting Logging setup!


/Users/Lionel/Public/Git/GitHub/mathnet-numerics/docs/tools/build-docs.fsx(26,1): error FS0078: Unable to find the file 'Microsoft.Web.XmlTransform.dll' in any of
 /Library/Frameworks/Mono.framework/Versions/4.0.4/lib/mono/4.5
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/packages/FSharp.Formatting/.
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/packages/FSharp.Formatting/lib/net40
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/packages/FSharp.Formatting/../FSharp.Compiler.Service/lib/net45
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/packages/FSharp.Formatting/../FSharpVSPowerTools.Core/lib/net45
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/docs/tools
 /Library/Frameworks/Mono.framework/Versions/4.0.4/lib/mono/4.5/
Running build failed.
Error:
System.Exception: Generating documentation failed
  at FSI_0001.Build.generateDocs (Boolean fail, Boolean local) [0x00000] in <filename unknown>:0 
  at [email protected] (Microsoft.FSharp.Core.Unit _arg2) [0x00000] in <filename unknown>:0 
  at Fake.TargetHelper+targetFromTemplate@155[Microsoft.FSharp.Core.Unit].Invoke (Microsoft.FSharp.Core.Unit unitVar0) [0x00000] in <filename unknown>:0 
  at Fake.TargetHelper.runSingleTarget (Fake.TargetTemplate`1 target) [0x00000] in <filename unknown>:0 

---------------------------------------------------------------------
Build Time Report
---------------------------------------------------------------------
Target         Duration
------         --------
Start          00:00:00.0008006
Clean          00:00:00.0382193
ApplyVersion   00:00:00.0804056
Prepare        00:00:00.0000392
BuildMain      00:00:28.8446678
Build          00:00:00.0000672
CleanDocs      00:00:00.0006310
Total:         00:00:38.4068042
Status:        Failure
---------------------------------------------------------------------
  1) System.Exception: Generating documentation failed
  at FSI_0001.Build.generateDocs (Boolean fail, Boolean local) [0x00000] in <filename unknown>:0 
  at [email protected] (Microsoft.FSharp.Core.Unit _arg2) [0x00000] in <filename unknown>:0 
  at Fake.TargetHelper+targetFromTemplate@155[Microsoft.FSharp.Core.Unit].Invoke (Microsoft.FSharp.Core.Unit unitVar0) [0x00000] in <filename unknown>:0 
  at Fake.TargetHelper.runSingleTarget (Fake.TargetTemplate`1 target) [0x00000] in <filename unknown>:0 
---------------------------------------------------------------------
lionel:mathnet-numerics Lionel$

The text was updated successfully, but these errors were encountered:

lionpeloux · 2015-10-18T12:25:44Z

Just one more question : have you ever thought about a readthedoc version of the doc ? It might simplify the process of documenting mathnet ?

Lionel

cdrnet · 2015-10-26T18:42:17Z

Thanks for reporting this. I've upgraded to a newer version of Fsharp.Formatting (1.10 -> 1.12), if this doesn't resolve the issue we may want to open an issue over there.

Wouldn't readthedoc depend on a local installation of both python and sphinx, and thus no longer be self-contained (and in fact introduce a whole new development ecosystem)? Neither would necessarily be a blocker, but I've been quite happy with Fsharp.Formatting so far.

lionpeloux · 2015-10-27T10:02:48Z

Dear Christopher,

I've pulled the latest revision of the master branch but I still get the same error while building the doc :

Time Elapsed 00:00:18.4307190
Finished Target: BuildMain
Starting Target: Build (==> BuildMain)
Finished Target: Build
Starting Target: CleanDocs (==> Start, Build)
Deleting contents of out/docs
Finished Target: CleanDocs
Starting Target: Docs (==> CleanDocs, Build)
fsharpi --define:RELEASE build-docs.fsx
FSharp.Formatting Information: 0 : FSharp.Formatting Logging setup!
Yaaf.FSharp.Scriping Information: 0 : Yaaf.FSharp.Scripting Logging setup!


/Users/Lionel/Public/Git/GitHub/mathnet-numerics/docs/tools/build-docs.fsx(26,1): error FS0078: Unable to find the file 'Microsoft.Web.XmlTransform.dll' in any of
 /Library/Frameworks/Mono.framework/Versions/4.0.4/lib/mono/4.5
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/packages/FSharp.Formatting/.
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/packages/FSharp.Formatting/lib/net40
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/packages/FSharp.Formatting/../FSharp.Compiler.Service/lib/net45
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/packages/FSharp.Formatting/../FSharpVSPowerTools.Core/lib/net45
 /Users/Lionel/Public/Git/GitHub/mathnet-numerics/docs/tools
 /Library/Frameworks/Mono.framework/Versions/4.0.4/lib/mono/4.5/
Running build failed.
Error:
System.Exception: Generating documentation failed
  at FSI_0001.Build.generateDocs (Boolean fail, Boolean local) [0x00000] in <filename unknown>:0
  at [email protected] (Microsoft.FSharp.Core.Unit _arg1) [0x00000] in <filename unknown>:0
  at Fake.TargetHelper+targetFromTemplate@195[Microsoft.FSharp.Core.Unit].Invoke (Microsoft.FSharp.Core.Unit unitVar0) [0x00000] in <filename unknown>:0
  at Fake.TargetHelper.runSingleTarget (Fake.TargetTemplate`1 target) [0x00000] in <filename unknown>:0

---------------------------------------------------------------------
Build Time Report
---------------------------------------------------------------------
Target         Duration
------         --------
Start          00:00:00.0002999
Clean          00:00:00.0393224
ApplyVersion   00:00:00.0570878
Prepare        00:00:00.0000296
BuildMain      00:00:18.6538081
Build          00:00:00.0000557
CleanDocs      00:00:00.0005591
Total:         00:00:24.2969990
Status:        Failure
---------------------------------------------------------------------
  1) System.Exception: Generating documentation failed
  at FSI_0001.Build.generateDocs (Boolean fail, Boolean local) [0x00000] in <filename unknown>:0
  at [email protected] (Microsoft.FSharp.Core.Unit _arg1) [0x00000] in <filename unknown>:0
  at Fake.TargetHelper+targetFromTemplate@195[Microsoft.FSharp.Core.Unit].Invoke (Microsoft.FSharp.Core.Unit unitVar0) [0x00000] in <filename unknown>:0
  at Fake.TargetHelper.runSingleTarget (Fake.TargetTemplate`1 target) [0x00000] in <filename unknown>:0
---------------------------------------------------------------------

lionpeloux · 2015-10-27T11:12:55Z

For RTD use, it looks quite promising, but may not be adapted to this project. It's an idea that may (or may not !) be explored.

It's true that you need a local install of sphinx (however very easy to do) if you want to render the doc on your local machine.

But on the RTD service, you can set up a webhook to the github \docs folder, so it rebuilds the docs automatically every time you append to github. It provides also an automatic pdf version of your doc (useful when you're just an end-user of mathnet and did not clone the repo, if you're working off-line).

However I'm not sure you can easily generate an auto-doc of your code by reading the docstrings you've written. That could be a problem to make API doc.

Otherwise, the RTD sphinx theme looks pretty good. And it's responsive. All you need is to write .rst or .md doc file. See RTD : adding markdown support.

The .Net Core Help is on RTD.
So autodoc of code might be released soon, as explained here. I've also found a sphinx .Net domain.

cdrnet · 2015-11-08T17:18:40Z

The docs build problem could be related to: fsprojects/ProjectScaffold#210

lionpeloux · 2015-11-09T12:24:11Z

Thanks Christoph,
I’ve tried to compile the doc agin, but it still doesn’t work ...

Le 8 nov. 2015 à 18:18, Christoph Ruegg [email protected] a écrit :

The docs build problem could be related to: fsprojects/ProjectScaffold#210 fsprojects/ProjectScaffold#210
—
Reply to this email directly or view it on GitHub #346 (comment).

cdrnet · 2015-11-20T05:34:53Z

fsprojects/FSharp.Formatting#328

Adapt and apply patch from fsprojects/ProjectScaffold#217

cdrnet · 2015-11-24T20:40:00Z

I've changed the way we execute the doc generation script. This seems to resolve such build problems on OS X in other projects. Could you give it a spin? Thanks!

lionpeloux · 2015-11-26T21:27:31Z

Hi Chris,

I’ve just build the doc on my mac : it’s working !

Thanks,
Lionel

Le 24 nov. 2015 à 21:40, Christoph Ruegg [email protected] a écrit :

I've changed the way we execute the doc generation script. This seems to resolve such build problems on OS X in other projects. Could you give it a spin? Thanks!

—
Reply to this email directly or view it on GitHub #346 (comment).

cdrnet · 2015-11-27T05:54:24Z

Great, thanks for the update!

Leaving this open for now as readthedocs would still be an option.

matthid mentioned this issue Nov 20, 2015

use FAKE for documentation generation. fsprojects/ProjectScaffold#217

Merged

cdrnet added a commit that referenced this issue Nov 24, 2015

Build: try to fix doc generation on OS X #346

58e09fe

Adapt and apply patch from fsprojects/ProjectScaffold#217

cdrnet closed this as completed Feb 13, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unable to build the doc #346

Unable to build the doc #346

lionpeloux commented Oct 18, 2015

lionpeloux commented Oct 18, 2015

cdrnet commented Oct 26, 2015

lionpeloux commented Oct 27, 2015

lionpeloux commented Oct 27, 2015

cdrnet commented Nov 8, 2015

lionpeloux commented Nov 9, 2015

cdrnet commented Nov 20, 2015

cdrnet commented Nov 24, 2015

lionpeloux commented Nov 26, 2015

cdrnet commented Nov 27, 2015

Unable to build the doc #346

Unable to build the doc #346

Comments

lionpeloux commented Oct 18, 2015

lionpeloux commented Oct 18, 2015

cdrnet commented Oct 26, 2015

lionpeloux commented Oct 27, 2015

lionpeloux commented Oct 27, 2015

cdrnet commented Nov 8, 2015

lionpeloux commented Nov 9, 2015

cdrnet commented Nov 20, 2015

cdrnet commented Nov 24, 2015

lionpeloux commented Nov 26, 2015

cdrnet commented Nov 27, 2015