We are planning on posting a new build 1.0.60 tomorrow. This build will have the new fanr architecture and the completely redesigned documentation infrastructure.
The major theme is bundling everything required for documentation into the pod zip itself so that fanr repos can drive docs straight off pod zip file. So we have designed a new apidoc format and for pods where you wish to generate HTML for the source, we are now bundling source code into the zip itself too.
I just want to give everybody a heads up that the plan for the 1.0.60 distro is exclude with HTML docs and the src code. If you want to generate offline HTML docs on your machine you can generate it from the pods using the command:
fan compilerDoc -all
If you want the entire source code tree, then you will pull it from Mercurial. I think anybody working with source is probably already doing this anyways.
This will reduce the distro down to what is required for runtime with some examples, a couple other things.
tcolarThu 1 Sep 2011
Just to confirm, the pod will still contain their own fandoc right ?
brianThu 1 Sep 2011
Just to confirm, the pod will still contain their own fandoc right ?
Yes, but what exactly do you mean?
The fandoc used to be shipped as a special text file called apidoc. This format has been completely been written to include all the reflection data needed to build docs without using normal system reflection. So its a different design. However, I do plan to keep Type.doc and Slot.doc working as before (except they won't have the "@" meta lines anymore).
tcolarThu 1 Sep 2011
Just wanted to make sure Type.doc would still pull the doc. So you answered that.
brian Wed 31 Aug 2011
We are planning on posting a new build 1.0.60 tomorrow. This build will have the new fanr architecture and the completely redesigned documentation infrastructure.
The major theme is bundling everything required for documentation into the pod zip itself so that fanr repos can drive docs straight off pod zip file. So we have designed a new apidoc format and for pods where you wish to generate HTML for the source, we are now bundling source code into the zip itself too.
I just want to give everybody a heads up that the plan for the 1.0.60 distro is exclude with HTML docs and the src code. If you want to generate offline HTML docs on your machine you can generate it from the pods using the command:
If you want the entire source code tree, then you will pull it from Mercurial. I think anybody working with source is probably already doing this anyways.
This will reduce the distro down to what is required for runtime with some examples, a couple other things.
tcolar Thu 1 Sep 2011
Just to confirm, the pod will still contain their own fandoc right ?
brian Thu 1 Sep 2011
Yes, but what exactly do you mean?
The fandoc used to be shipped as a special text file called apidoc. This format has been completely been written to include all the reflection data needed to build docs without using normal system reflection. So its a different design. However, I do plan to keep
Type.docandSlot.docworking as before (except they won't have the "@" meta lines anymore).tcolar Thu 1 Sep 2011
Just wanted to make sure Type.doc would still pull the doc. So you answered that.