www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - Appreciation for Adrdox

reply Chris Piker <chris hoopjump.com> writes:
Hi Adam Ruppe

Just wanted to drop a note of thanks for your documentation 
generator.

   It's nice!

My internal project has become complicated enough that proper 
documentation
seemed to be in order.  Over the course of today I've tested 
three systems:

   * straight ddoc generated via dmd
   * ddox via dub -b ddox
   * and adrdox.

I found the output of adrdox to be the most visually appealing of 
the three
and the easiest to navigate.  In addition it also had the least 
number of bugs
(zero so far).

Since documentation is the first thing a new user notices about a 
library, I
thank you for helping me to make a good first impression for my 
work.

Best,
May 12 2021
next sibling parent reply Adam D. Ruppe <destructionator gmail.com> writes:
On Thursday, 13 May 2021 at 04:23:26 UTC, Chris Piker wrote:

 Just wanted to drop a note of thanks for your documentation 
 generator.


Excellent! Glad it is working out.



 I found the output of adrdox to be the most visually appealing 
 of the three and the easiest to navigate.


Note that its syntax is actually only partially compatible with 
ddoc. I cut a bunch of their features and added a bunch of my own

I keep a page here listing things:
http://dpldocs.info/experimental-docs/adrdox.syntax.html

I don't like accidentally triggering markdown so i put that in 
its own blocks for the most part but the biggest thing is if you 
reference anything with [brackets.around.it], it does a name 
lookup and links for you.

So you can use local names or fully qualified names and help to 
interlink things you reference. [thing_to_link|text to display] 
is also a thing you can do (the bar came from wikipedia syntax 
rather than markdown).

It can even reorganize things

http://dpldocs.info/experimental-docs/adrdox.syntax.html#symbol-grouping

which is how this listing is achieved:
http://arsd-official.dpldocs.info/arsd.nanovega.html#members


So a bunch of cool things you can dip into once you commit to 
using my incompatible syntax.


 In addition it also had the least number of bugs (zero so far).


Lucky you! lol. I always try to fix them within a week of people 
reporting them to me so that probably helps.

I kinda hate it when people report bugs tho because they're 
almost always massively complicated. I've fixed most the easy 
ones already so what's left tends to take hours to figure out and 
since my code is really, really bad (I'd rewrite it totally 
differenly if I had infinite time but instead I tend to just keep 
patching more filth on top of the already rotting core...) it is 
easy to make regressions.

But also since I can auto-generate pages from various projects 
problems tend to get noticed before too long.


That said don't hesitate to email me or message on the irc if 
something does come up and I'll see what I can do.
May 13 2021
parent reply Chris Piker <chris hoopjump.com> writes:
On Thursday, 13 May 2021 at 15:57:39 UTC, Adam D. Ruppe wrote:

 That said don't hesitate to email me or message on the irc if 
 something does come up and I'll see what I can do.


I appreciate the invite and am happy to use which ever contact 
method you prefer the most, though since some of the discussions 
could be beneficial to other users, would you consider enabling 
the discussion feature for your 
[adrdox](https://github.com/adamdruppe/adrdox) github project?
May 13 2021
parent Adam D. Ruppe <destructionator gmail.com> writes:
On Friday, 14 May 2021 at 00:57:33 UTC, Chris Piker wrote:

 discussions could be beneficial to other users, would you 
 consider enabling the discussion feature for your 
 [adrdox](https://github.com/adamdruppe/adrdox) github project?


oh i've never even heard of that before.

https://github.com/adamdruppe/adrdox/discussions/47

as long as it emails me when people post cuz otherwise i'll never 
see it.
May 13 2021
prev sibling next sibling parent Imperatorn <johan_forsberg_86 hotmail.com> writes:
On Thursday, 13 May 2021 at 04:23:26 UTC, Chris Piker wrote:

 Hi Adam Ruppe

 Just wanted to drop a note of thanks for your documentation 
 generator.

   It's nice!

 My internal project has become complicated enough that proper 
 documentation
 seemed to be in order.  Over the course of today I've tested 
 three systems:

   * straight ddoc generated via dmd
   * ddox via dub -b ddox
   * and adrdox.

 I found the output of adrdox to be the most visually appealing 
 of the three
 and the easiest to navigate.  In addition it also had the least 
 number of bugs
 (zero so far).

 Since documentation is the first thing a new user notices about 
 a library, I
 thank you for helping me to make a good first impression for my 
 work.

 Best,


Agreed! Adam deserves a medal (autocorrect suggested medley 🎶?) 
for helping us all! (Also he's a 100x dev but does "one file dev" 
so you have to divide by 10 but still a 10x:er) 🥉
May 13 2021
prev sibling parent reply Guillaume Piolat <first.last gmail.com> writes:
On Thursday, 13 May 2021 at 04:23:26 UTC, Chris Piker wrote:

 Hi Adam Ruppe

 Just wanted to drop a note of thanks for your documentation 
 generator.

   It's nice!


There is a patreon for it and we can perhaps even reach the next 
goal together!
https://www.patreon.com/adam_d_ruppe
May 14 2021
parent Chris Piker <chris hoopjump.com> writes:
On Friday, 14 May 2021 at 14:25:55 UTC, Guillaume Piolat wrote:

 There is a patreon for it and we can perhaps even reach the 
 next goal together!
 https://www.patreon.com/adam_d_ruppe


Hey, thanks for mentioning it!  I chipped in.  Maybe someday Adam 
can quit his day job.

...now if only I had enough spare cash to buy indented dmd error 
message formatting for deep template types.
May 16 2021