Good day.

I publish small library for code.dlang.org. BitBucket is a hosting, now.

There are many ddoc commentaries inside sources. 'dub --build=docs' or 'dub --build=ddox' creates two types of documentation. But when I specify url to repository itself or to any of these files - 'Documentation' tab is empty.

How to make documentation right? Is there any tutorial?

On Wednesday, 4 November 2020 at 05:19:19 UTC, Vitaly Livshic wrote:
> Good day.
>
> I publish small library for code.dlang.org. BitBucket is a hosting, now.
>
> There are many ddoc commentaries inside sources. 'dub --build=docs' or 'dub --build=ddox' creates two types of documentation. But when I specify url to repository itself or to any of these files - 'Documentation' tab is empty.
>
> How to make documentation right? Is there any tutorial?

It doesn't seem to work for me too so I've basically ignored it... for now. If you have ddoc in your code, you may build it and host the static files...GitHub pages??

On Wednesday, 4 November 2020 at 05:19:19 UTC, Vitaly Livshic wrote:
> Good day.
>
> I publish small library for code.dlang.org. BitBucket is a hosting, now.
>
> There are many ddoc commentaries inside sources. 'dub --build=docs' or 'dub --build=ddox' creates two types of documentation. But when I specify url to repository itself or to any of these files - 'Documentation' tab is empty.
>
> How to make documentation right? Is there any tutorial?

Oh so one thing too, you'll have a README.md file in your repo... with the information you want users to see as the package description...something like an example of how to use it and what the package does.

See my blog post https://aberba.com/2020/why-no-one-is-using-your-d-library/

On Wednesday, 4 November 2020 at 05:19:19 UTC, Vitaly Livshic wrote:
> I publish small library for code.dlang.org. BitBucket is a hosting, now.

What is your thing? this one?

https://code.dlang.org/packages/dateformat

The content under documentation there is actually supposed to be your README file. I don't know why that is empty.

But if you change the "documentation url" back to the default then the tab itself will link to here:

http://dateformat.dpldocs.info/dateformat.html

which automatically generates stuff based on inline comments. I see it tried once before and failed because of a bug in my bitbucket code downloader but that's fixed now and it appears to work.

So you might just switch back to that and let my service generate it. Use the "clear cache" button at the very bottom of a page to force a rebuild if it gets stale.

On Wednesday, 4 November 2020 at 11:12:19 UTC, aberba wrote:
> On Wednesday, 4 November 2020 at 05:19:19 UTC, Vitaly Livshic wrote:
> Oh so one thing too, you'll have a README.md file in your repo...

 I wrote it and this is additional problem. But thanks for your help, anyway.

On Wednesday, 4 November 2020 at 18:28:24 UTC, Adam D. Ruppe wrote:
> On Wednesday, 4 November 2020 at 05:19:19 UTC, Vitaly Livshic wrote:
>> I publish small library for code.dlang.org. BitBucket is a hosting, now.
>
> What is your thing? this one?
>
> https://code.dlang.org/packages/dateformat

 Yes it is.

> The content under documentation there is actually supposed to be your README file. I don't know why that is empty.
 This is strange. All packages that I see contains README.md and I include it too. Bitbucket shows it without problem.

> http://dateformat.dpldocs.info/dateformat.html

Thanks for this URL. Its works fine by itself. I switch to it and see nothing even in a Tor browser on https://code.dlang.org/packages/dateformat :(.

>
> which automatically generates stuff based on inline comments. I see it tried once before and failed because of a bug in my bitbucket code downloader but that's fixed now and it appears to work.
 Obviously, some self-evident rules is unknown for me.

On Friday, 6 November 2020 at 04:36:50 UTC, Vitaly Livshic wrote:
>  This is strange. All packages that I see contains README.md and I include it too. Bitbucket shows it without problem.

I have no control over that part and don't know why it is not showing up.

> Thanks for this URL. Its works fine by itself. I switch to it and see nothing even in a Tor browser on

You can click on the "documentation" tab though and it opens a link to it.

All the documentation URL thing does is change the destination of that link.

The text underneath it is supposed to be pulled out of the readme but it must be a bug in the code.dlang.org site. I don't run that though so I can't help there :(

On Friday, 6 November 2020 at 04:42:30 UTC, Adam D. Ruppe wrote:
> On Friday, 6 November 2020 at 04:36:50 UTC, Vitaly Livshic wrote:
> The text underneath it is supposed to be pulled out of the readme but it must be a bug in the code.dlang.org site. I don't run that though so I can't help there :(

Anyway, thanks for your help.

On Friday, 6 November 2020 at 04:53:03 UTC, Vitaly Livshic wrote:
> On Friday, 6 November 2020 at 04:42:30 UTC, Adam D. Ruppe wrote:
>> On Friday, 6 November 2020 at 04:36:50 UTC, Vitaly Livshic wrote:
>> The text underneath it is supposed to be pulled out of the readme but it must be a bug in the code.dlang.org site. I don't run that though so I can't help there :(
>
> Anyway, thanks for your help.

I submitted an issue for this to the dub-registry repository on github:

https://github.com/dlang/dub-registry/issues/482

Hopefully someone familiar with the project can figure out what's going on.

On Friday, 6 November 2020 at 13:23:36 UTC, Paul Backus wrote:
> On Friday, 6 November 2020 at 04:53:03 UTC, Vitaly Livshic wrote:

> I submitted an issue for this to the dub-registry repository on github:
>
> https://github.com/dlang/dub-registry/issues/482

Thanks, I shall not touch README.md, to make situation more determined.