[howto] Serve ddox documentation on github.io deployed by Travis CI

Martin Nowak code at dawg.eu
Thu Jan 18 17:05:50 UTC 2018


On Saturday, 13 January 2018 at 11:42:42 UTC, Bastiaan Veelo 
wrote:
> On Saturday, 13 January 2018 at 10:02:18 UTC, Jacob Carlborg 
> wrote:
>> On 2018-01-13 05:59, Martin Nowak wrote:
>>> On Wednesday, 10 January 2018 at 08:50:37 UTC, Bastiaan Veelo 
>>> wrote:
>>>>> Maybe worthwile to add this scaffolding to dub or some 
>>>>> other tool? Anyone volunteering?
>>>>
>>>> This could be a good idea. Probably even better is to let 
>>>> code.dlang.org take care of it, which would make the whole 
>>>> token issue and setup obsolete.
>>> 
>>> What do you mean with "taking care of it"?
>>
>> Perhaps to automatically generate documentation for all 
>> packages on code.dlang.org and publish it there as well.
>
> Yes that is what I meant, sorry for being vague. It’s been 
> suggested before I think. It would be a lot more work than what 
> you are suggesting and one does not have to exclude the other: 
> a bot could clone the project repositories and generate 
> documentation for each, without project owners needing to 
> manage tokens.

I don't think it's good idea to centralize this.
First the existing tools are easy enough to use, though some 
articles are necessary to spread the knowledge.
Second it'd put more burden on very few people that are already 
maintaining an unproportionate part of the overall ecosystem.
Third ppl. might want to use different doc generators, styles, or 
host a project site.
Fourth you create new problems like CSRF when hostings docs on 
one domain, hence github pages have one subdomain per user.

We might want to add a configurable doc link to project settings 
on the registry, but the Readme is already a good or even better 
place.


More information about the Digitalmars-d-announce mailing list