digitalmars.D.learn - DDoc generation
- Russel Winder (16/16) Sep 18 2020 Hi,
- Steven Schveighoffer (5/13) Sep 18 2020 You can make explicit ddoc files, and compile those along with your
- Russel Winder (11/17) Sep 18 2020 On Fri, 2020-09-18 at 09:02 -0400, Steven Schveighoffer via Digitalmars-...
- James Blachly (8/21) Sep 18 2020 I am also learning about ddoc generation (something that IMO could stand...
- Russel Winder (17/41) Sep 19 2020 -d-
- Mike Parker (2/11) Sep 19 2020 https://github.com/dlang/dconf.org/tree/master/2019
- Jacob Carlborg (5/11) Sep 18 2020 There's no built-in support for that. You might want to look at some
- Russel Winder (13/26) Sep 19 2020 is
- Jacob Carlborg (8/10) Sep 19 2020 Yes. The problem is that most things in D are compared with C or
- aberba (4/15) Sep 21 2020 +1.
- Jacob Carlborg (14/16) Sep 19 2020 If you use Dub, you can run `dub build -b ddox` and it will use
- DlangUser38 (5/13) Sep 20 2020 harbored-mod [1] generates an index with the module list (example
Hi, I am trying to get to grips with DDoc for documenting an application. Getti= ng the individual module HTML files seems to be the easy bit. The question is = how to get an index.html (or equivalent) so as to have an application level ent= ry point to the generated documentation. =20 --=20 Russel. =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Dr Russel Winder t: +44 20 7585 2200 41 Buckmaster Road m: +44 7770 465 077 London SW11 1EN, UK w: www.russel.org.uk
Sep 18 2020
On 9/18/20 7:41 AM, Russel Winder wrote:Hi, I am trying to get to grips with DDoc for documenting an application. Getting the individual module HTML files seems to be the easy bit. The question is how to get an index.html (or equivalent) so as to have an application level entry point to the generated documentation.You can make explicit ddoc files, and compile those along with your application. https://dlang.org/spec/ddoc.html#using_ddoc_for_other_documentation -Steve
Sep 18 2020
On Fri, 2020-09-18 at 09:02 -0400, Steven Schveighoffer via Digitalmars-d- learn wrote: [=E2=80=A6]=20 it ddoc files, and compile those along with your=20 application. =20 https://dlang.org/spec/ddoc.html#using_ddoc_for_other_documentation =20Any small project examples anywhere? --=20 Russel. =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Dr Russel Winder t: +44 20 7585 2200 41 Buckmaster Road m: +44 7770 465 077 London SW11 1EN, UK w: www.russel.org.uk
Sep 18 2020
On 9/18/20 9:35 AM, Russel Winder wrote:On Fri, 2020-09-18 at 09:02 -0400, Steven Schveighoffer via Digitalmars-d- learn wrote: […]I am also learning about ddoc generation (something that IMO could stand to be much better , ahem, documented). A nice example I've found is the libmir site: https://www.libmir.org/ http://mir-algorithm.libmir.org/ (mir-core., mir-random., etc.) and its documentation generation infrastructure: https://github.com/libmir/circle-dlangit ddoc files, and compile those along with your application. https://dlang.org/spec/ddoc.html#using_ddoc_for_other_documentationAny small project examples anywhere?
Sep 18 2020
Russel Winder <russel winder.org.uk> On Fri, 2020-09-18 at 20:22 -0400, James Blachly via Digitalmars-d-learn wrote:On 9/18/20 9:35 AM, Russel Winder wrote:-d-On Fri, 2020-09-18 at 09:02 -0400, Steven Schveighoffer via Digitalmars==20learn wrote: =20 [=E2=80=A6]=20 I am also learning about ddoc generation (something that IMO could stand=it ddoc files, and compile those along with your application. =20 https://dlang.org/spec/ddoc.html#using_ddoc_for_other_documentation =20=20 Any small project examples anywhere? =20to be much better , ahem, documented). A nice example I've found is the==20libmir site: =20 https://www.libmir.org/ http://mir-algorithm.libmir.org/ (mir-core., mir-random., etc.) =20 and its documentation generation infrastructure: =20 https://github.com/libmir/circle-dlangYikes. Maybe it is just a first sight thing, but if that is what is needed = to handle Mir, maybe I should try and make Doxygen work for my D projects =E2= =80=93 though doxygen only works "to some extent D". --=20 Russel. =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Dr Russel Winder t: +44 20 7585 2200 41 Buckmaster Road m: +44 7770 465 077 London SW11 1EN, UK w: www.russel.org.uk
Sep 19 2020
On Friday, 18 September 2020 at 13:35:05 UTC, Russel Winder wrote:On Fri, 2020-09-18 at 09:02 -0400, Steven Schveighoffer via Digitalmars-d- learn wrote: […]https://github.com/dlang/dconf.org/tree/master/2019it ddoc files, and compile those along with your application. https://dlang.org/spec/ddoc.html#using_ddoc_for_other_documentationAny small project examples anywhere?
Sep 19 2020
On 2020-09-18 13:41, Russel Winder wrote:Hi, I am trying to get to grips with DDoc for documenting an application. Getting the individual module HTML files seems to be the easy bit. The question is how to get an index.html (or equivalent) so as to have an application level entry point to the generated documentation.There's no built-in support for that. You might want to look at some other doc generating tool if those support that. -- /Jacob Carlborg
Sep 18 2020
On Sat, 2020-09-19 at 08:12 +0200, Jacob Carlborg via Digitalmars-d-learn wrote:On 2020-09-18 13:41, Russel Winder wrote:isHi, =20 I am trying to get to grips with DDoc for documenting an application. Getting the individual module HTML files seems to be the easy bit. The question=Doesn't that then make the whole DDoc system fairly useless, despite it's u= se in Phobos? --=20 Russel. =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Dr Russel Winder t: +44 20 7585 2200 41 Buckmaster Road m: +44 7770 465 077 London SW11 1EN, UK w: www.russel.org.ukhow to get an index.html (or equivalent) so as to have an application level entry point to the generated documentation.=20 There's no built-in support for that. You might want to look at some=20 other doc generating tool if those support that.
Sep 19 2020
On Saturday, 19 September 2020 at 07:43:24 UTC, Russel Winder wrote:Doesn't that then make the whole DDoc system fairly useless, despite it's use in Phobos?Yes. The problem is that most things in D are compared with C or C++. People are praising that the built-in support for unit tests and Ddoc are the best things that have happened since sliced bread. But if you compare with C or C++ the bar isn't very high. -- /Jacob Carlborg
Sep 19 2020
On Saturday, 19 September 2020 at 11:39:45 UTC, Jacob Carlborg wrote:On Saturday, 19 September 2020 at 07:43:24 UTC, Russel Winder wrote:+1. Couldn't agree more.Doesn't that then make the whole DDoc system fairly useless, despite it's use in Phobos?Yes. The problem is that most things in D are compared with C or C++. People are praising that the built-in support for unit tests and Ddoc are the best things that have happened since sliced bread. But if you compare with C or C++ the bar isn't very high. -- /Jacob Carlborg
Sep 21 2020
On Saturday, 19 September 2020 at 07:43:24 UTC, Russel Winder wrote:Doesn't that then make the whole DDoc system fairly useless, despite it's use in Phobos?If you use Dub, you can run `dub build -b ddox` and it will use Ddox to build the documentation. This will include an index page listing all modules. This will actually start a local web server to show the documentation. It's possible to generate documentation offline as well [1]. Or it should be pretty straightforward to write a simple script that iterates all D files and generates documentation. Then iterate all HTML files and output a simple index.html file. [1] https://github.com/rejectedsoftware/ddox#generating-offline-documentation -- /Jacob Carlborg
Sep 19 2020
On Friday, 18 September 2020 at 11:41:05 UTC, Russel Winder wrote:Hi, I am trying to get to grips with DDoc for documenting an application. Getting the individual module HTML files seems to be the easy bit. The question is how to get an index.html (or equivalent) so as to have an application level entry point to the generated documentation.harbored-mod [1] generates an index with the module list (example [2]) [1] https://gitlab.com/basile.b/harbored-mod [2] https://basile.b.gitlab.io/iz/index.html
Sep 20 2020