No idea how much work it is to add another section specifically for the
front end, but the front end docs really don't belong co-mingled with
the phobos and library directories. It's part of neither.
On 6/6/17 3:13 PM, Seb via Digitalmars-d wrote:
Hi all,
I have excellent news on the front of DMD becoming a library.
DMD on dlang.org
----------------
Since today DMD's documentation is browseable online on the released docs:
Ddoc: https://dlang.org/phobos/ddmd_mars.html
Ddox: https://dlang.org/library/ddmd/mars.html
In particular this is pretty handy with DDox's symbol search (top
right), see e.g. [2] for example screenshots.
I guess that not many people noticed, but the prereleases pages (i.e.
the current master branch) contained the DMD pages for quite some time:
Ddoc: https://dlang.org/phobos-prerelease/ddmd_mars.html
Ddox: https://dlang.org/library-prerelease/ddmd/mars.html
Status quo
----------
Many pages aren't well-documented for now and the blacklist of exposed
modules [3] needs some expansion as well.
However, fixing these pages is now just a PR away (see the "Improve this
page" button on the top-right).
Building DMD documentation pages
--------------------------------
If you build the pages yourself, you will be interested in the
`-prerelease` ones as they are built from latest (i.e. your local dmd
repository).
Just clone dlang.org and for the Ddoc pages, execute the
`dmd-prerelease` target:
make -f posix.mak dmd-prerelease html
Of course the `html` target is only needed once and don't get confused
by the files being in web/phobos-prerelease.
Or alternatively with Ddox (and the files being in web/library-prerelease):
make -f posix.mak apidocs-prerelease
There's also a bit hidden target that will spawn a Vibe.d instance and
is faster to start as it only renders a documentation page on-demand:
make -f posix.mak apidocs-serve
Other work
----------
- Jacob is putting a ton of effort into making DMD easily accessible via
DUB [4]
- Razvan is making sure that you can use the resulting library [5]
[1] Enable DMD docs on dlang.org PR:
https://github.com/dlang/dlang.org/pull/1671
[2] DDox search examples : http://imgur.com/a/lddjt
[3] Module blacklist:
https://github.com/dlang/dlang.org/blob/master/posix.mak#L73
[4] DMD as DUB package PR: https://github.com/dlang/dmd/pull/6771
[5] DMD as a library PR: https://github.com/dlang/dmd/pull/6836
