Thread overview
Generating API documention
Jan 10
George
Jan 10
Seb
Jan 10
George
6 days ago
George
January 10
What do people use to generate nice looking and simple html documentation for their projects? I would be glad (and if possible), someone could share some actual instructions rather than just tell me ddoc. For example I have seen the libmir (http://docs.mir.dlang.io/latest/index.html) and I would love to generate something similar for a project I am working on.

Thank you and best wishes.
George

January 10
On Thursday, 10 January 2019 at 07:04:52 UTC, George wrote:
> What do people use to generate nice looking and simple html documentation for their projects? I would be glad (and if possible), someone could share some actual instructions rather than just tell me ddoc. For example I have seen the libmir (http://docs.mir.dlang.io/latest/index.html) and I would love to generate something similar for a project I am working on.
>
> Thank you and best wishes.
> George

It's not amazing, but scod and ddox is dead simple.

On phone so can't format nicely, but to your dub.json:

    "-ddoxTool" : "scod"

Then just dub build -ddox and it will generate a docs/ directory. I use GitHub pages to host mine, automatically generated and uploaded by Travis-CI on pushes.

January 10
On Thursday, 10 January 2019 at 08:50:27 UTC, Anonymouse wrote:
> Then just dub build -ddox
Naturally dub build -b ddox.

January 10
On Thursday, 10 January 2019 at 07:04:52 UTC, George wrote:
> What do people use to generate nice looking and simple html documentation for their projects? I would be glad (and if possible), someone could share some actual instructions rather than just tell me ddoc. For example I have seen the libmir (http://docs.mir.dlang.io/latest/index.html) and I would love to generate something similar for a project I am working on.
>
> Thank you and best wishes.
> George

This was actually done with Ddoc (author of the ddoc setup for Mir here) ;-)
See: https://github.com/libmir/mir/tree/master/doc


It uses the dlang.org Ddoc theme and customizes it a bit, but is fairly tricky to setup and maintain.
Also, it doesn't work with dub.

For a nice out of the box experience, I would recommend scod

https://github.com/MartinNowak/scod

Example project: https://github.com/MartinNowak/bloom


Also note that with dpldocs.info you'll automatically get documentation for your project once its published on the Dub registry, see e.g. https://pbackus.github.io/sumtype/sumtype.html
January 10
On Thursday, 10 January 2019 at 10:33:00 UTC, Seb wrote:
> On Thursday, 10 January 2019 at 07:04:52 UTC, George wrote:
>> [...]
>
> This was actually done with Ddoc (author of the ddoc setup for Mir here) ;-)
> See: https://github.com/libmir/mir/tree/master/doc
>
>
> It uses the dlang.org Ddoc theme and customizes it a bit, but is fairly tricky to setup and maintain.
> Also, it doesn't work with dub.
>
> For a nice out of the box experience, I would recommend scod
>
> https://github.com/MartinNowak/scod
>
> Example project: https://github.com/MartinNowak/bloom
>
>
> Also note that with dpldocs.info you'll automatically get documentation for your project once its published on the Dub registry, see e.g. https://pbackus.github.io/sumtype/sumtype.html

Thank you!
January 11
On Thursday, 10 January 2019 at 07:04:52 UTC, George wrote:
> What do people use to generate nice looking and simple html documentation for their projects?

If you like my style <http://dpldocs.info/experimental-docs/arsd.simpledisplay.html> and syntax <https://github.com/adamdruppe/arsd/blob/master/simpledisplay.d#L41> you can use my site.

If you wanna run yourself, go here: https://github.com/adamdruppe/adrdox clone that, hit make (on Linux at least) and run the program: `./doc2 /path/to/your/project`. It spits out html in a generated-docs folder.


OR if you are on the code.dlang.org dub repository, I have a server that will run it all for you by just going to

your-dub-project-name.dpldocs.info
6 days ago
On Friday, 11 January 2019 at 14:16:45 UTC, Adam D. Ruppe wrote:
> On Thursday, 10 January 2019 at 07:04:52 UTC, George wrote:
>> What do people use to generate nice looking and simple html documentation for their projects?
>
> If you like my style <http://dpldocs.info/experimental-docs/arsd.simpledisplay.html> and syntax <https://github.com/adamdruppe/arsd/blob/master/simpledisplay.d#L41> you can use my site.
>
> If you wanna run yourself, go here: https://github.com/adamdruppe/adrdox clone that, hit make (on Linux at least) and run the program: `./doc2 /path/to/your/project`. It spits out html in a generated-docs folder.
>
>
> OR if you are on the code.dlang.org dub repository, I have a server that will run it all for you by just going to
>
> your-dub-project-name.dpldocs.info

thank you Adam!