Re: [Boost-users] [Fit] upcoming formal review for Boost.Fit

Subject: Re: [Boost-users] [Fit] upcoming formal review for Boost.Fit
From: paul Fultz (pfultz2_at_[hidden])
Date: 2016-02-28 16:23:01

On Sunday, February 28, 2016 12:23 PM, Edward Diener <eldiener_at_[hidden]> wrote:

>
>
>On 2/27/2016 11:16 AM, Vicente J. Botet Escriba wrote:
>> Dear Boost community,
>>
>> The formal review of Paul Fultz II's Fit library starts on Wednesday, 2nd March and ends on 13th March.
>
>How do I generate the docs or run the tests for my local copy of Fit ?

>

You can build and run the tests by building the check target. For those
unfamiliar with cmake, first configure the build directory with cmake:

mkdir build
cd build
cmake ..
cd ..

Next build the check target using the native build system(such as make or
msbuild). CMake can call the native build system to build the target 'check',
like so:

cmake --build build --config Release --target check

Also, the library can be installed by invoking the 'install' target.

The documentation needs to be built using mkdocs. You can install mkdocs and
the boost theme with pip like this:

pip install mkdocs mkdocs-boost

Then to build the documentation, first `setup.py` must be run to extract the
documentation and examples from the source code, then `mkdocs` can be invoked,
like this:

python setup.py
mkdocs build -t boost

And the documentation will be in the 'doc/html' directory.

Paul