Can't really use the created dox about dox HOT 6 CLOSED

-r should be set to the base path of the links. If you are planning to host your documentation on http://yourserver.com/kraut, then you should invoke dox with -r /kraut.

from dox.

You should probably make that more clear… I have read it as the input-xml from one of the announcement posts in haxe list.

from dox.

I don't disagree, but it seems hard to explain this in only a few words so we could add it to the command line help... I guess we could add one or two example usages to the command line.

from dox.

Just move it to the end of the list and assume . if ommited?

haxedoc is happy with input.xml and output dir, why do you need such a complicated parameterset for dox?

why not just run hlr dox input.xml output/path, creating absolute URLs in the filesystem? Only with -r provided use absolute to webroot with -r value as basepath?

from dox.

The reason for the base path is that every page in the tree needs to load assets (CSS, JS, images) from the root.

Haxedoc doesn't need this as every page is self contained.

We could calculate the relative path to the root for every page, but there quite a few places it gets used (including index.js). Another generated var in a script tag maybe?

On 19/06/2013, at 8:07 AM, "Norbert Melzer" <[email protected]mailto:[email protected]> wrote:

Just move it to the end of the list and assume . if ommited?

haxedoc is happy with input.xml and output dir, why do you need such a complicated parameterset for dox?

why not just run hlr dox input.xml output/path, creating absolute URLs in the filesystem? Only with -r provided use absolute to webroot with -r value as basepath?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/17#issuecomment-19646008.

from dox.

I think the problem here is that we do not derive the -r path from the -o path if only the latter is provided. We set some default values here:
https://github.com/dpeek/dox/blob/master/src/dox/Dox.hx#L19

And then overwrite them as provided by command line. It might be better to start without any initialization, read the command line and then fill in the defaults if they are not set. This would allow to set defaults depending on set values.

from dox.