digitalmars.D.announce - DDocs.org: auto-generated documentation for all DUB projects (WIP)
- Kiith-Sa (26/26) Feb 10 2015 DDocs.org (http://ddocs.org) is a repository of documentation for
- MrSmith (6/34) Feb 10 2015 That is pretty cool! I will put a link to it in all my project
- Kiith-Sa (14/57) Feb 10 2015 There's a bunch of macros used in many D projects not documented
- Rikki Cattermole (3/28) Feb 10 2015 Right this needs to be made first class link wise on dlang.org and
- NVolcz (2/5) Feb 10 2015 Killer project! Nice work!
- Phil (1/1) Feb 10 2015 This is already really helpful in its current form. Thanks!
- Vadim Lopatin (2/30) Feb 11 2015 Very useful project!
- =?UTF-8?B?TWFydGluIERyYcWhYXI=?= via Digitalmars-d-announce (3/8) Feb 11 2015 That is fantastic! I always wanted something like CPAN for D...
- Mathias LANG (18/46) Feb 11 2015 Awesome ! I've wanted to do it for quite some time, I think it's
- Kiith-Sa (7/62) Feb 11 2015 Yes, I'm using libddoc (not current harbored directly - using a
- Ilya Yaroshenko (1/1) Feb 11 2015 Thanks!
- John Colvin (8/36) Feb 11 2015 Great work. I noticed a few mistakes in the layout:
- Kiith-Sa (10/17) Feb 11 2015 The CSS is actually correct, I'm using display: flex for the
- John Colvin (3/23) Feb 12 2015 Ok, well something was broken before (safari 8.0.3), but it all
- Jacob Carlborg (4/7) Feb 11 2015 This is awesome :)
- Andrej Mitrovic via Digitalmars-d-announce (5/10) Feb 11 2015 Yeah, and it might just make us get off our lazy asses and fix the
- extrawurst (2/5) Feb 11 2015 This is huge! Great work
- Andrej Mitrovic via Digitalmars-d-announce (7/8) Feb 12 2015 It would be nice to be able to jump to the project's hosted repository
- Kiith-Sa (3/14) Feb 15 2015 Good idea, added the feature.
- ponce (2/30) Feb 12 2015 I've waited eagerly for someone to do this! Thank you.
DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. The idea is to make documenting D projects as simple as possible, to the point where you don't need to do any work to get documentation for your project other than adding it to the DUB registry. Also, users can now browse documentation for DUB projects even if the author was too lazy to generate it themselves (assuming thy did include some documentation comments). Note that this is still in a very early stage, it was put together in a very quick-and-dirty style by a person with little webdev experience. Currently it just scans `code.dlang.org`, looking for changes (yes, I know, this will break as soon as code.dlang.org changes, I plan to raise issue/s (PRs?) to the dub registry project so it can have a full/stable API, but I wanted to get something to work *right now*. Code is here: * ddocs.org: https://github.com/kiith-sa/ddocs.org * hmod-dub: https://github.com/kiith-sa/hmod-dub * harbored-mod: https://github.com/kiith-sa/harbored-mod Background: When optimizing harbored-mod by testing it on big D projects (gtk-d, tango, vibe.d, etc.), I wrote a simple tool to fetch/generate docs for any DUB project; I got carried away and used that as base for a tool that checks for changes in the DUB registry and generates docs for all projects.
Feb 10 2015
On Tuesday, 10 February 2015 at 22:40:18 UTC, Kiith-Sa wrote:DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. The idea is to make documenting D projects as simple as possible, to the point where you don't need to do any work to get documentation for your project other than adding it to the DUB registry. Also, users can now browse documentation for DUB projects even if the author was too lazy to generate it themselves (assuming thy did include some documentation comments). Note that this is still in a very early stage, it was put together in a very quick-and-dirty style by a person with little webdev experience. Currently it just scans `code.dlang.org`, looking for changes (yes, I know, this will break as soon as code.dlang.org changes, I plan to raise issue/s (PRs?) to the dub registry project so it can have a full/stable API, but I wanted to get something to work *right now*. Code is here: * ddocs.org: https://github.com/kiith-sa/ddocs.org * hmod-dub: https://github.com/kiith-sa/hmod-dub * harbored-mod: https://github.com/kiith-sa/harbored-mod Background: When optimizing harbored-mod by testing it on big D projects (gtk-d, tango, vibe.d, etc.), I wrote a simple tool to fetch/generate docs for any DUB project; I got carried away and used that as base for a tool that checks for changes in the DUB registry and generates docs for all projects.That is pretty cool! I will put a link to it in all my project readmes. I've noticed that License: "a$(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0)." gets rendered as "a". Am I doing it wrong?
Feb 10 2015
"Kiith-Sa" <kiithsacmp gmail.com> On Tuesday, 10 February 2015 at 23:53:19 UTC, MrSmith wrote:On Tuesday, 10 February 2015 at 22:40:18 UTC, Kiith-Sa wrote:There's a bunch of macros used in many D projects not documented in the language reference. They seem to be defined somewhere in Phobos/Druntime (? - not sure), not really built in, but I add them as I find them so compatibility is kept. Added $WEB to harbored-mod now. There already also is LINK, LINK2, and HTTP... and of course Markdown [link](http://link.org) - but that doesn't work with plain DDoc generators. The change can take a while to propagate to your packages as ddocs.org waits a few days before regenerating docs for releases that already have docs generated and <2 days for known branches (~master) so it doesn't constantly regenerate docs for everything - it is feasible now but won't be if the DUB registry gets bigger as fast as I expect.DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. The idea is to make documenting D projects as simple as possible, to the point where you don't need to do any work to get documentation for your project other than adding it to the DUB registry. Also, users can now browse documentation for DUB projects even if the author was too lazy to generate it themselves (assuming thy did include some documentation comments). Note that this is still in a very early stage, it was put together in a very quick-and-dirty style by a person with little webdev experience. Currently it just scans `code.dlang.org`, looking for changes (yes, I know, this will break as soon as code.dlang.org changes, I plan to raise issue/s (PRs?) to the dub registry project so it can have a full/stable API, but I wanted to get something to work *right now*. Code is here: * ddocs.org: https://github.com/kiith-sa/ddocs.org * hmod-dub: https://github.com/kiith-sa/hmod-dub * harbored-mod: https://github.com/kiith-sa/harbored-mod Background: When optimizing harbored-mod by testing it on big D projects (gtk-d, tango, vibe.d, etc.), I wrote a simple tool to fetch/generate docs for any DUB project; I got carried away and used that as base for a tool that checks for changes in the DUB registry and generates docs for all projects.That is pretty cool! I will put a link to it in all my project readmes. I've noticed that License: "a$(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0)." gets rendered as "a". Am I doing it wrong?
Feb 10 2015
On 11/02/2015 11:40 a.m., Kiith-Sa wrote:DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. The idea is to make documenting D projects as simple as possible, to the point where you don't need to do any work to get documentation for your project other than adding it to the DUB registry. Also, users can now browse documentation for DUB projects even if the author was too lazy to generate it themselves (assuming thy did include some documentation comments). Note that this is still in a very early stage, it was put together in a very quick-and-dirty style by a person with little webdev experience. Currently it just scans `code.dlang.org`, looking for changes (yes, I know, this will break as soon as code.dlang.org changes, I plan to raise issue/s (PRs?) to the dub registry project so it can have a full/stable API, but I wanted to get something to work *right now*. Code is here: * ddocs.org: https://github.com/kiith-sa/ddocs.org * hmod-dub: https://github.com/kiith-sa/hmod-dub * harbored-mod: https://github.com/kiith-sa/harbored-mod Background: When optimizing harbored-mod by testing it on big D projects (gtk-d, tango, vibe.d, etc.), I wrote a simple tool to fetch/generate docs for any DUB project; I got carried away and used that as base for a tool that checks for changes in the DUB registry and generates docs for all projects.Right this needs to be made first class link wise on dlang.org and code.dlang.org
Feb 10 2015
On Tuesday, 10 February 2015 at 22:40:18 UTC, Kiith-Sa wrote:DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added.Killer project! Nice work!
Feb 10 2015
This is already really helpful in its current form. Thanks!
Feb 10 2015
On Tuesday, 10 February 2015 at 22:40:18 UTC, Kiith-Sa wrote:DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. The idea is to make documenting D projects as simple as possible, to the point where you don't need to do any work to get documentation for your project other than adding it to the DUB registry. Also, users can now browse documentation for DUB projects even if the author was too lazy to generate it themselves (assuming thy did include some documentation comments). Note that this is still in a very early stage, it was put together in a very quick-and-dirty style by a person with little webdev experience. Currently it just scans `code.dlang.org`, looking for changes (yes, I know, this will break as soon as code.dlang.org changes, I plan to raise issue/s (PRs?) to the dub registry project so it can have a full/stable API, but I wanted to get something to work *right now*. Code is here: * ddocs.org: https://github.com/kiith-sa/ddocs.org * hmod-dub: https://github.com/kiith-sa/hmod-dub * harbored-mod: https://github.com/kiith-sa/harbored-mod Background: When optimizing harbored-mod by testing it on big D projects (gtk-d, tango, vibe.d, etc.), I wrote a simple tool to fetch/generate docs for any DUB project; I got carried away and used that as base for a tool that checks for changes in the DUB registry and generates docs for all projects.Very useful project!
Feb 11 2015
Dne 10.2.2015 v 23:40 Kiith-Sa via Digitalmars-d-announce napsal(a):DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. =20 ...That is fantastic! I always wanted something like CPAN for D... Thanks
Feb 11 2015
On Tuesday, 10 February 2015 at 22:40:18 UTC, Kiith-Sa wrote:DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. The idea is to make documenting D projects as simple as possible, to the point where you don't need to do any work to get documentation for your project other than adding it to the DUB registry. Also, users can now browse documentation for DUB projects even if the author was too lazy to generate it themselves (assuming thy did include some documentation comments). Note that this is still in a very early stage, it was put together in a very quick-and-dirty style by a person with little webdev experience. Currently it just scans `code.dlang.org`, looking for changes (yes, I know, this will break as soon as code.dlang.org changes, I plan to raise issue/s (PRs?) to the dub registry project so it can have a full/stable API, but I wanted to get something to work *right now*. Code is here: * ddocs.org: https://github.com/kiith-sa/ddocs.org * hmod-dub: https://github.com/kiith-sa/hmod-dub * harbored-mod: https://github.com/kiith-sa/harbored-mod Background: When optimizing harbored-mod by testing it on big D projects (gtk-d, tango, vibe.d, etc.), I wrote a simple tool to fetch/generate docs for any DUB project; I got carried away and used that as base for a tool that checks for changes in the DUB registry and generates docs for all projects.Awesome ! I've wanted to do it for quite some time, I think it's really important we get that as a part of code.dlang.org (as well as compatibility badges, but that's another story. Regarding the macros: I recently completed the set of definitions in libddoc ( https://github.com/economicmodeling/libddoc/commit/82fcd8fdcdfe0809437f 415361ef92ee21a5c12 ), so if you're based on Harbored, you should have everything you need. I'm currently working on a fully compliant macro parser in libddoc. The macro WEB is not part of the standard definition, it's part of dlang.org's definitions, which you can find on Github (.ddoc files). More precisely, it's defined in html.ddoc ( https://github.com/D-Programming-Language/dlang.org/blob/master/html.ddoc ). I guess it can make sense to had that file included by default, but at the same time I'd like to avoid projects documentation to rely on non-standard behavior.
Feb 11 2015
On Wednesday, 11 February 2015 at 08:41:26 UTC, Mathias LANG wrote:On Tuesday, 10 February 2015 at 22:40:18 UTC, Kiith-Sa wrote:Yes, I'm using libddoc (not current harbored directly - using a fork) so those builtin macros already work. I don't want to include all the phobos/dlang.org macros, but I will add them on case-by-case basis when people use them in their projects' docs so the docs still work.DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. The idea is to make documenting D projects as simple as possible, to the point where you don't need to do any work to get documentation for your project other than adding it to the DUB registry. Also, users can now browse documentation for DUB projects even if the author was too lazy to generate it themselves (assuming thy did include some documentation comments). Note that this is still in a very early stage, it was put together in a very quick-and-dirty style by a person with little webdev experience. Currently it just scans `code.dlang.org`, looking for changes (yes, I know, this will break as soon as code.dlang.org changes, I plan to raise issue/s (PRs?) to the dub registry project so it can have a full/stable API, but I wanted to get something to work *right now*. Code is here: * ddocs.org: https://github.com/kiith-sa/ddocs.org * hmod-dub: https://github.com/kiith-sa/hmod-dub * harbored-mod: https://github.com/kiith-sa/harbored-mod Background: When optimizing harbored-mod by testing it on big D projects (gtk-d, tango, vibe.d, etc.), I wrote a simple tool to fetch/generate docs for any DUB project; I got carried away and used that as base for a tool that checks for changes in the DUB registry and generates docs for all projects.Awesome ! I've wanted to do it for quite some time, I think it's really important we get that as a part of code.dlang.org (as well as compatibility badges, but that's another story. Regarding the macros: I recently completed the set of definitions in libddoc ( https://github.com/economicmodeling/libddoc/commit/82fcd8fdcdfe0809437f 415361ef92ee21a5c12 ), so if you're based on Harbored, you should have everything you need. I'm currently working on a fully compliant macro parser in libddoc. The macro WEB is not part of the standard definition, it's part of dlang.org's definitions, which you can find on Github (.ddoc files). More precisely, it's defined in html.ddoc ( https://github.com/D-Programming-Language/dlang.org/blob/master/html.ddoc ). I guess it can make sense to had that file included by default, but at the same time I'd like to avoid projects documentation to rely on non-standard behavior.
Feb 11 2015
On Tuesday, 10 February 2015 at 22:40:18 UTC, Kiith-Sa wrote:DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. The idea is to make documenting D projects as simple as possible, to the point where you don't need to do any work to get documentation for your project other than adding it to the DUB registry. Also, users can now browse documentation for DUB projects even if the author was too lazy to generate it themselves (assuming thy did include some documentation comments). Note that this is still in a very early stage, it was put together in a very quick-and-dirty style by a person with little webdev experience. Currently it just scans `code.dlang.org`, looking for changes (yes, I know, this will break as soon as code.dlang.org changes, I plan to raise issue/s (PRs?) to the dub registry project so it can have a full/stable API, but I wanted to get something to work *right now*. Code is here: * ddocs.org: https://github.com/kiith-sa/ddocs.org * hmod-dub: https://github.com/kiith-sa/hmod-dub * harbored-mod: https://github.com/kiith-sa/harbored-mod Background: When optimizing harbored-mod by testing it on big D projects (gtk-d, tango, vibe.d, etc.), I wrote a simple tool to fetch/generate docs for any DUB project; I got carried away and used that as base for a tool that checks for changes in the DUB registry and generates docs for all projects.Great work. I noticed a few mistakes in the layout: div.main-description { width: 160%; should be 100% The e-o , p-z links are overlapping the arrow symbols. http://ddocs.org/favicon.ico is a 404
Feb 11 2015
Great work. I noticed a few mistakes in the layout:
div.main-description
{
width: 160%;
should be 100%
The e-o , p-z links are overlapping the arrow symbols.
http://ddocs.org/favicon.ico is a 404
The CSS is actually correct, I'm using display: flex for the
intro/developer info.
I added prefixes so it works in browsers like Safari that don't
yet support the official syntax. It'll still look ugly in IE9 and
older (and frankly, I don't see that as an issue). Same with the
arrows/links, where I'm using transform: rotate().
Browser support for these features:
http://caniuse.com/#feat=flexbox
http://caniuse.com/#feat=transforms2d
Also, added a favicon (just a png of the dlang.org favicon).
Feb 11 2015
On Thursday, 12 February 2015 at 03:42:54 UTC, Kiith-Sa wrote:Ok, well something was broken before (safari 8.0.3), but it all looks fine now.Great work. I noticed a few mistakes in the layout: div.main-description { width: 160%; should be 100% The e-o , p-z links are overlapping the arrow symbols. http://ddocs.org/favicon.ico is a 404The CSS is actually correct, I'm using display: flex for the intro/developer info. I added prefixes so it works in browsers like Safari that don't yet support the official syntax. It'll still look ugly in IE9 and older (and frankly, I don't see that as an issue). Same with the arrows/links, where I'm using transform: rotate(). Browser support for these features: http://caniuse.com/#feat=flexbox http://caniuse.com/#feat=transforms2d
Feb 12 2015
On 2015-02-10 23:40, Kiith-Sa wrote:DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added.This is awesome :) -- /Jacob Carlborg
Feb 11 2015
On 2/11/15, Jacob Carlborg via Digitalmars-d-announce <digitalmars-d-announce puremagic.com> wrote:On 2015-02-10 23:40, Kiith-Sa wrote:Yeah, and it might just make us get off our lazy asses and fix the documentation of our projects. :) Great work, and a great initiative!DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added.This is awesome :)
Feb 11 2015
On Tuesday, 10 February 2015 at 22:40:18 UTC, Kiith-Sa wrote:DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added.This is huge! Great work
Feb 11 2015
On 2/10/15, Kiith-Sa via Digitalmars-d-announce <digitalmars-d-announce puremagic.com> wrote:DDocs.org (http://ddocs.org)It would be nice to be able to jump to the project's hosted repository in the docs page (maybe generate a github icon with a link somewhere?) E.g. I'm here: http://ddocs.org/bloom/latest/dawg/bloom.html But want to get the link to the github repository. I'd have to go to the homepage and search for the package.
Feb 12 2015
On Thursday, 12 February 2015 at 15:27:14 UTC, Andrej Mitrovic wrote:On 2/10/15, Kiith-Sa via Digitalmars-d-announce <digitalmars-d-announce puremagic.com> wrote:Good idea, added the feature.DDocs.org (http://ddocs.org)It would be nice to be able to jump to the project's hosted repository in the docs page (maybe generate a github icon with a link somewhere?) E.g. I'm here: http://ddocs.org/bloom/latest/dawg/bloom.html But want to get the link to the github repository. I'd have to go to the homepage and search for the package.
Feb 15 2015
On Tuesday, 10 February 2015 at 22:40:18 UTC, Kiith-Sa wrote:DDocs.org (http://ddocs.org) is a repository of documentation for DUB projects that automatically re-generates docs as new projects/releases/branch changes are added. The idea is to make documenting D projects as simple as possible, to the point where you don't need to do any work to get documentation for your project other than adding it to the DUB registry. Also, users can now browse documentation for DUB projects even if the author was too lazy to generate it themselves (assuming thy did include some documentation comments). Note that this is still in a very early stage, it was put together in a very quick-and-dirty style by a person with little webdev experience. Currently it just scans `code.dlang.org`, looking for changes (yes, I know, this will break as soon as code.dlang.org changes, I plan to raise issue/s (PRs?) to the dub registry project so it can have a full/stable API, but I wanted to get something to work *right now*. Code is here: * ddocs.org: https://github.com/kiith-sa/ddocs.org * hmod-dub: https://github.com/kiith-sa/hmod-dub * harbored-mod: https://github.com/kiith-sa/harbored-mod Background: When optimizing harbored-mod by testing it on big D projects (gtk-d, tango, vibe.d, etc.), I wrote a simple tool to fetch/generate docs for any DUB project; I got carried away and used that as base for a tool that checks for changes in the DUB registry and generates docs for all projects.I've waited eagerly for someone to do this! Thank you.
Feb 12 2015