digitalmars.D - Updating dlang.org documentation
- Mike (8/8) Feb 05 2014 I've submitted a couple of pull request to fix some dlang.org's
- Brad Anderson (9/17) Feb 05 2014 The makefiles have an "html" target for running DDoc. There's a
- Brad Anderson (5/25) Feb 05 2014 Oh, and if I remember correctly the target puts the results in an
- Russel Winder (10/12) Feb 05 2014 I wonder that the developer cannot just say make and the make scripts
- Brad Anderson (11/18) Feb 05 2014 My understanding (someone can correct me if I'm wrong) is that
- Russel Winder (12/21) Feb 05 2014 QED.
I've submitted a couple of pull request to fix some dlang.org's documentation, using github's web editor. The changes were simple, so I really didn't need to render the .dd file to verify my changes. However, if I make a larger change, I'd like to be able to see the end result as readers will see it. How can I render the .dd files to html? Thanks, Mike
Feb 05 2014
On Wednesday, 5 February 2014 at 12:06:44 UTC, Mike wrote:I've submitted a couple of pull request to fix some dlang.org's documentation, using github's web editor. The changes were simple, so I really didn't need to render the .dd file to verify my changes. However, if I make a larger change, I'd like to be able to see the end result as readers will see it. How can I render the .dd files to html? Thanks, MikeThe makefiles have an "html" target for running DDoc. There's a std.ddoc file with macros in the dlang.org repository that the phobos docs references so you'll want to ensure the paths between phobos and dlang.org are right in the makefile (I believe DOCSRC defaults to "../dlang.org"). Once you are sure the paths are good, just run: make -f {posix.mak/win32.mak} html (choose the right makefile for your platform)
Feb 05 2014
On Wednesday, 5 February 2014 at 18:01:19 UTC, Brad Anderson wrote:On Wednesday, 5 February 2014 at 12:06:44 UTC, Mike wrote:Oh, and if I remember correctly the target puts the results in an odd location (at least on Windows). Something like ../../phobos so you may want to check and change that before you generate them.I've submitted a couple of pull request to fix some dlang.org's documentation, using github's web editor. The changes were simple, so I really didn't need to render the .dd file to verify my changes. However, if I make a larger change, I'd like to be able to see the end result as readers will see it. How can I render the .dd files to html? Thanks, MikeThe makefiles have an "html" target for running DDoc. There's a std.ddoc file with macros in the dlang.org repository that the phobos docs references so you'll want to ensure the paths between phobos and dlang.org are right in the makefile (I believe DOCSRC defaults to "../dlang.org"). Once you are sure the paths are good, just run: make -f {posix.mak/win32.mak} html (choose the right makefile for your platform)
Feb 05 2014
On Wed, 2014-02-05 at 18:01 +0000, Brad Anderson wrote: […]make -f {posix.mak/win32.mak} html (choose the right makefile for your platform)I wonder that the developer cannot just say make and the make scripts sort out which platform the person is on. -- Russel. ============================================================================= Dr Russel Winder t: +44 20 7585 2200 voip: sip:russel.winder ekiga.net 41 Buckmaster Road m: +44 7770 465 077 xmpp: russel winder.org.uk London SW11 1EN, UK w: www.russel.org.uk skype: russel_winder
Feb 05 2014
On Wednesday, 5 February 2014 at 18:09:58 UTC, Russel Winder wrote:On Wed, 2014-02-05 at 18:01 +0000, Brad Anderson wrote: […]My understanding (someone can correct me if I'm wrong) is that platform specific makefiles are used to account for different versions of "make" itself, not to customize the actual build for specific platforms (although this has happened by consequence of the makefiles being split by platform). A unified makefile has been desired but it'd require everyone to acquire and use compatible versions of "make" on every platform and that is more tricky. On Windows, Digital Mars "make" is provided with DMD/DMC so its rather easy for everyone to get their hands on.make -f {posix.mak/win32.mak} html (choose the right makefile for your platform)I wonder that the developer cannot just say make and the make scripts sort out which platform the person is on.
Feb 05 2014
On Wed, 2014-02-05 at 18:42 +0000, Brad Anderson wrote: […]My understanding (someone can correct me if I'm wrong) is that platform specific makefiles are used to account for different versions of "make" itself, not to customize the actual build for specific platforms (although this has happened by consequence of the makefiles being split by platform). A unified makefile has been desired but it'd require everyone to acquire and use compatible versions of "make" on every platform and that is more tricky. On Windows, Digital Mars "make" is provided with DMD/DMC so its rather easy for everyone to get their hands on.QED. Make was a revolution and a revelation in 1978: kudos to Stuart Feldman and collaborators. Today it is 2014. There are now better build systems. Ones that cope with platform differences. -- Russel. ============================================================================= Dr Russel Winder t: +44 20 7585 2200 voip: sip:russel.winder ekiga.net 41 Buckmaster Road m: +44 7770 465 077 xmpp: russel winder.org.uk London SW11 1EN, UK w: www.russel.org.uk skype: russel_winder
Feb 05 2014