View mode: basic / threaded / horizontal-split · Log in · Help
October 12, 2012
Re: revamped candydoc
On 2012-10-11 22:16, Aziz K. wrote:
> On Thu, 11 Oct 2012 21:33:15 +0200, Jacob Carlborg <doob@me.com> wrote:
>
>> If you're using git you could add Tango as a submodule. I'm talking
>> about Tango-D2 here, I heard you're porting Dil to D2. It might be
>> possible for D1 as well using git svn.
>>
>
> Interesting, I didn't realize until now that you can do that with git.
> Is it possible to set the external git repo to a specific commit? I'll
> consider this option. Thanks!

Have a look at this documentation of submodules:

http://git-scm.com/book/en/Git-Tools-Submodules

Be sure to point submodules to a public address.

-- 
/Jacob Carlborg
October 12, 2012
Re: revamped candydoc
On Thursday, 11 October 2012 at 14:26:54 UTC, Dan wrote:
> Also, pointers to any doc generation setup with decent styling 
> that works out of the box would be great.

bootDoc[1] uses Twitter's Bootstrap theme for styling, and has a 
lot of extra features implemented with JavaScript. It works right 
out of the box as a git submodule and has a fair bit of 
documentation. The modules.ddoc file format is compatible with 
that of candyDoc.

[1] https://github.com/JakobOvrum/bootDoc
October 12, 2012
Re: revamped candydoc
On Thursday, 11 October 2012 at 18:08:47 UTC, Aziz K. wrote:
> I'll be happy to help you compile DIL yourself. That way I can 
> see where my assumptions are false and my instructions are 
> lacking and make it work for different platforms and needs. 
> I've been considering just copying Tango's files to my src 
> folder, because it would make compiling much easier (or going 
> the more difficult route and automatically download/build Tango 
> from build.py.)
>
> Can you join me at #dil on freenode.net? Chatting will be much 
> faster than e-mailing.

Thanks for all the answers/suggestions. Aziz helped me get set up 
with dil and it is quite nice. Just for better understanding 
though, I'd like to determine why candydoc is not working for me. 
Either my command line/setup is wrong or others using this 
successfully do not have package nesting. I think the problem is 
for every module an html file is generated without the package 
prefix in the name. This presents a problem in what is generated, 
because links inside the html refer to the package qualified 
name. For example:

tmp$ mkdir pkgouter
tmp$ mkdir pkgouter/pkg1
tmp$ mkdir pkgouter/pkg2
tmp$ echo "/** Mod foo */ module pkgouter.pkg1.foo;" > 
pkgouter/pkg1/foo.d
tmp$ echo "/** Mod foo */ module pkgouter.pkg2.foo;" > 
pkgouter/pkg2/foo.d
tmp$ git clone https://github.com/eldar/candydoc.git
Cloning into 'candydoc'...
remote: Counting objects: 145, done.
remote: Compressing objects: 100% (89/89), done.
remote: Total 145 (delta 70), reused 130 (delta 55)
Receiving objects: 100% (145/145), 117.46 KiB, done.
Resolving deltas: 100% (70/70), done.
tmp$ echo "MODULES=\$(MODULE pkgouter.pkg1.foo) \$(MODULE 
pkgouter.pkg2.foo)">candydoc/modules.ddoc
tmp$ dmd -c -D  candydoc/candy.ddoc candydoc/modules.ddoc 
pkgouter/pkg1/foo.d pkgouter/pkg2/foo.d
tmp$ ls
candydoc  foo.html  foo.o  pkgouter

Only foo.html was generated referencing pkgouter.pkg2.foo and 
pkgouter.pkg2.foo. So, if I could get the dmd to output the html 
filename as the package qualified name I think it would just work.

Thanks
Dan
October 12, 2012
Re: revamped candydoc
On Fri, 12 Oct 2012 08:19:23 +0200, Jacob Carlborg <doob@me.com> wrote:

> Have a look at this documentation of submodules:
>
> http://git-scm.com/book/en/Git-Tools-Submodules
>
> Be sure to point submodules to a public address.
>

That was a good read, but unfortunately it deterred me from using  
submodules. Sounds like too much trouble for me. It's not worth the hassle  
if it requires that much care and attention. Only git can get away with  
such atrocious usability issues. lol
October 12, 2012
Re: revamped candydoc
On Fri, 12 Oct 2012 08:16:54 +0200, Jacob Carlborg <doob@me.com> wrote:

> Why is that? Tango is working just fine and Phobos is still missing some  
> stuff that Tango has. Actually, I'm using both and there's nothing wrong  
> with that. Tango is just yet another third party library.
>

Yeah, no disagreement there. It's working fine thanks to the awesome work  
SiegeLord put into porting it to D2. I'll definitely stay with Tango, but  
external dependencies can be quite annoying, so maybe I'll just copy the  
modules I need and leave the rest.
October 12, 2012
Re: revamped candydoc
On Thu, 11 Oct 2012 21:30:11 +0200, Jacob Carlborg <doob@me.com> wrote:

> I liked the style that the Tango docs are using much better.
>

What? You don't like my soft, green colours? Shame on you! :P

Ok, I'm not happy with the style myself, but I want to concentrate on  
functionality more atm.
October 13, 2012
Re: revamped candydoc
On 2012-10-12 17:05, Aziz K. wrote:

> Yeah, no disagreement there. It's working fine thanks to the awesome
> work SiegeLord put into porting it to D2. I'll definitely stay with
> Tango, but external dependencies can be quite annoying, so maybe I'll
> just copy the modules I need and leave the rest.

Ok, fair enough.

-- 
/Jacob Carlborg
October 13, 2012
Re: revamped candydoc
On 2012-10-12 16:55, Aziz K. wrote:

> That was a good read, but unfortunately it deterred me from using
> submodules. Sounds like too much trouble for me. It's not worth the
> hassle if it requires that much care and attention. Only git can get
> away with such atrocious usability issues. lol

Ok, I actually never read that, I probably should have. git submodules 
are not hard to use it's not harder than any other feature of git.

What you need to do is the following:

$ cd dil
$ git submodule add git://github.com/SiegeLord/Tango-D2.git
$ git commit -a -m "Add Tango-D2 as a submodule"

Then when cloning dil use the following command:

$ git clone --recursive git://path.to/dil/repository.git

If you want to update to a the latest version of Tango do:

$ cd dil/Tango-D2
$ git pull
$ cd ..
$ git commit -a -m "Update to latest version Tango-D2"

When another user needs to update his/her clone of dil, this is the 
command to run:

$ git pull
$ git submodule update --init --recursive

It's fairly simple, not that many extra commands to run.

-- 
/Jacob Carlborg
October 13, 2012
Re: revamped candydoc
On 2012-10-12 21:06, Aziz K. wrote:

> What? You don't like my soft, green colours? Shame on you! :P

Hehe :)

> Ok, I'm not happy with the style myself, but I want to concentrate on
> functionality more atm.

Understandable. I'm not very good with design and graphics myself so I 
probably shouldn't complain that much.

-- 
/Jacob Carlborg
Next ›   Last »
1 2
Top | Discussion index | About this forum | D home