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 |
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 <[hidden email]> 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 |
In reply to this post by Pavel Tupitsyn
Pavel, thanks!
It is the great news! Looks like DocFX will save 30-40 min. 2017-09-05 11:16 GMT+03:00 Pavel Tupitsyn <[hidden email]>: > 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 > -- Ilya Suntsov |
DocFX takes around 30 seconds on my machine.
> if you already tried that Yes, everything is done on my side, see JIRA ticket [4] and preview [5] above. On Tue, Sep 5, 2017 at 11:45 AM, Ilya Suntsov <[hidden email]> wrote: > Pavel, thanks! > It is the great news! > Looks like DocFX will save 30-40 min. > > 2017-09-05 11:16 GMT+03:00 Pavel Tupitsyn <[hidden email]>: > > > 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 > > > > > > -- > Ilya Suntsov > |
Great news, thanks a lot!
On Tue, Sep 5, 2017 at 11:47 AM, Pavel Tupitsyn <[hidden email]> wrote: > DocFX takes around 30 seconds on my machine. > > > if you already tried that > Yes, everything is done on my side, see JIRA ticket [4] and preview [5] > above. > > On Tue, Sep 5, 2017 at 11:45 AM, Ilya Suntsov <[hidden email]> > wrote: > > > Pavel, thanks! > > It is the great news! > > Looks like DocFX will save 30-40 min. > > > > 2017-09-05 11:16 GMT+03:00 Pavel Tupitsyn <[hidden email]>: > > > > > 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 > > > > > > > > > > > -- > > Ilya Suntsov > > > |
Looks good to me. Clean layout, fast build - do we need anything else?
On Tue, Sep 5, 2017 at 12:06 PM, Oleg Ostanin <[hidden email]> wrote: > Great news, thanks a lot! > > On Tue, Sep 5, 2017 at 11:47 AM, Pavel Tupitsyn <[hidden email]> > wrote: > >> DocFX takes around 30 seconds on my machine. >> >> > if you already tried that >> Yes, everything is done on my side, see JIRA ticket [4] and preview [5] >> above. >> >> On Tue, Sep 5, 2017 at 11:45 AM, Ilya Suntsov <[hidden email]> >> wrote: >> >> > Pavel, thanks! >> > It is the great news! >> > Looks like DocFX will save 30-40 min. >> > >> > 2017-09-05 11:16 GMT+03:00 Pavel Tupitsyn <[hidden email]>: >> > >> > > 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 >> > > >> > >> > >> > >> > -- >> > Ilya Suntsov >> > >> > > |
Looks like everyone is ok with this. I'm going to merge these changes to
master. Doxygen-related stuff remains there for now just in case, we have a separate ticket to remove it: https://issues.apache.org/jira/browse/IGNITE-6267 On Wed, Sep 6, 2017 at 11:16 AM, Vladimir Ozerov <[hidden email]> wrote: > Looks good to me. Clean layout, fast build - do we need anything else? > > On Tue, Sep 5, 2017 at 12:06 PM, Oleg Ostanin <[hidden email]> > wrote: > > > Great news, thanks a lot! > > > > On Tue, Sep 5, 2017 at 11:47 AM, Pavel Tupitsyn <[hidden email]> > > wrote: > > > >> DocFX takes around 30 seconds on my machine. > >> > >> > if you already tried that > >> Yes, everything is done on my side, see JIRA ticket [4] and preview [5] > >> above. > >> > >> On Tue, Sep 5, 2017 at 11:45 AM, Ilya Suntsov <[hidden email]> > >> wrote: > >> > >> > Pavel, thanks! > >> > It is the great news! > >> > Looks like DocFX will save 30-40 min. > >> > > >> > 2017-09-05 11:16 GMT+03:00 Pavel Tupitsyn <[hidden email]>: > >> > > >> > > 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 > >> > > > >> > > >> > > >> > > >> > -- > >> > Ilya Suntsov > >> > > >> > > > > > |
Free forum by Nabble | Edit this page |