ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Sergey Kozlov <skoz...@gridgain.com>
Subject Re: New API docs look for Ignite.NET
Date Tue, 05 Sep 2017 08:44:28 GMT
Pavel

I like the idea to change Doxygen. It really becomes uncomfortable to
regenerate often.
Do you know how much DocFX faster than Doxygen (if you already tried that)?



On Tue, Sep 5, 2017 at 11:16 AM, Pavel Tupitsyn <ptupitsyn@apache.org>
wrote:

> Igniters and users,
>
> Historically we've been using Doxygen [1] to generate .NET API
> documentation [2].
>
> Recently it became very slow on our code base (more than 30 minutes to
> generate), and I could not find any solution or tweak to fix that. Other
> issues include outdated looks and limited customization possibilities.
>
> I propose to replace it with DocFX [3] [4]:
> - Popular .NET Foundation project
> - Good looks and usability out of the box
> - Easy to set up
>
> Our docs will look like this: [5]
> Let me know if you have any objections or suggestions.
>
> Pavel
>
>
> [1] http://www.stack.nl/~dimitri/doxygen/
> [2] https://ignite.apache.org/releases/latest/dotnetdoc/index.html
> [3] https://dotnet.github.io/docfx/
> [4] https://issues.apache.org/jira/browse/IGNITE-6253
> [5] https://ptupitsyn.github.io/docfx-test/api/index.html
>



-- 
Sergey Kozlov
GridGain Systems
www.gridgain.com

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message