Re: [boost] [Fit] Update: Request for feedback

On Tue, 2016-11-08 at 14:20 -0500, Edward Diener wrote:

On 11/8/2016 11:23 AM, Paul Fultz II wrote:

...

...

On Nov 8, 2016, at 10:06 AM, Edward Diener wrote:

On 11/8/2016 8:45 AM, Paul Fultz II wrote:

...

Hi,

I have made a lot of updates to the Fit library based on the changes suggested during the review earlier this year. I have also improved the documentation. I have expanded on the introductory materials and have add a lot more cross- referencing. The documentation can be found here:

http://fit.readthedocs.io http://fit.readthedocs.io/

Let me know of any feedback about the library either here on the mailing list or on Github issues.

Please provide a jamfile for creating the documentation locally.

The commands needed to build the documentation locally is here:

http://fit.readthedocs.io/en/latest/doc/src/building.html#documenta tion

"How to build the documentation" is in the documentation. That strikes  me as strange. I suggest you also put 'how to build the documentation"  into something that does not need to be built, like a readme.md file.

It is in the readme as well, here: https://github.com/pfultz2/Fit#documentation

...

I will try to add the command to bjam. Although, I am not entirely familiar with adding custom commands to bjam.

If you are not going to supply the documentation as part of the library,  I believe you will need to use Boost Build to build the documentation if  Fit is accepted into Boost. Providing additional means of building the  docs is up to you.

Got it, its been updated on 'master', so Boost Build will build the docs as well. I may add a 'doc' target on cmake to build the documentationa as well. I believe thats what Boost.Hana does. Paul