documentation build about mir HOT 11 CLOSED

Maybe Adam's new documentation generator is worth looking at.

Have you build something with Adam's docs?

from mir.

Nope, was just an idea. However I have done this Travis to s3 many times, so if you have a favorite doc generator, I would be happy to hack something together next week.

On March 31, 2016 5:44:25 PM GMT+03:00, Ilya Yaroshenko [email protected] wrote:

Maybe Adam's new documentation generator is worth looking at.

Have you build something with Adam's docs?

---

You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub:
#32 (comment)

from mir.

Nope, was just an idea. However I have done this Travis to s3 many times, so if you have a favorite doc generator, I would be happy to hack something together next week.

I like https://github.com/kiith-sa/harbored-mod and Adam's doc engine looks good too. Mir requires all DDOC macros from Phobos. This will add some problems.

from mir.

Mir requires all DDOC macros from Phobos. This will add some problems.

Hmm yeah this is going to be tricky, but maybe taking the macro definition from the dlang.org repo is already enough.

I am more worried about references to Phobos modules, so when using REF the link won't resolve, but perhaps as a workaround a simple regex could find these occurrences

An alternative would be to use the setup from dlang.org, but modified to only build Mir.
The advantages here is that we avoid ui bugs due to different documentation engines if a module will be merged to Phobos and their css design is pretty sweet.

On March 31, 2016 5:58:11 PM GMT+03:00, Ilya Yaroshenko [email protected] wrote:

Nope, was just an idea. However I have done this Travis to s3 many
times, so if you have a favorite doc generator, I would be happy to
hack something together next week.

I like https://github.com/kiith-sa/harbored-mod and Adam's doc engine
looks good too. Mir requires all DDOC macros from Phobos. This will add
some problems.

---

You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub:
#32 (comment)

from mir.

as bootDoc is working again - do you want to add that back to the Readme?

Btw should we archive every documentation version? We could just execute the s3 copy command to the git describe --abbrev=0 --tags (latest tag) too, but then we should probably provide a nice way for the user to switch between documentations and at the moment we didn't introduce any breaking changes - so just an idea once the first official version is released.

from mir.

as bootDoc is working again - do you want to add that back to the Readme?

We still need to add macros like LREF and others.

from mir.

Btw should we archive every documentation version? We could just execute the s3 copy command to the git describe --abbrev=0 --tags (latest tag) too, but then we should probably provide a nice way for the user to switch between documentations and at the moment we didn't introduce any breaking changes - so just an idea once the first official version is released.

This would be helpful

from mir.

After testing ddox, bootDoc, harbored-mod I gave@adamdruppe's new adrdox a try:
http://docs.mir.dlang.io/adrdox/mir.combinatorics.html

It's still in an experimental stage, but I really like the fact how easy it is to give it a custom skeleton :)

from mir.

Looks good

from mir.

I like https://github.com/kiith-sa/harbored-mod and Adam's doc engine looks good too

Seems like harbored is working again.
I gave it a try too: http://docs.mir.dlang.io/harbored/

from mir.

Fixed with #203

from mir.