February 11, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | Thanks! |
February 11, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | 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 |
February 11, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | 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 |
February 11, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to Jacob Carlborg | 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: >> 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 :) 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! |
February 11, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | 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
|
February 12, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to John Colvin | > 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). |
February 12, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | 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. |
February 12, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | 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.
|
February 12, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to Kiith-Sa | On Thursday, 12 February 2015 at 03:42:54 UTC, Kiith-Sa wrote:
>> 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
Ok, well something was broken before (safari 8.0.3), but it all looks fine now.
|
February 15, 2015 Re: DDocs.org: auto-generated documentation for all DUB projects (WIP) | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrej Mitrovic | 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:
>> 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.
Good idea, added the feature.
|
Copyright © 1999-2021 by the D Language Foundation