Menu

#188 Help file generation without compilation

Next Release
closed
5
2005-03-23
2005-03-22
No

Requested feature: an option for the (al least the
console) NDoc application to skip running the help
compiler after all help-related files are produced (MSDN
documenter, HTML Help output).

Context:
I love NDoc because it can generate extensive reference
documentation from source code. But a good help file
should include also "how to" articles or samples. These
are best created with your favorite help authoring
system. I'm working on a small tool that combines
the "how to" help files and the ones created by NDoc
into a single compiled help file. One of the options will
be to reorganise the contents of the NDoc generated
help reference.

For these types of tools, NDocConsole has to be run to
create the help files and help project files. NDoc always
runs the help compiler after the files have been created,
but that's a waste of time as my tool will compile the
files another time. Especially for large projects, it would
be great if you could turn off the compilation.

Discussion

  • Kevin Downs

    Kevin Downs - 2005-03-23

    Logged In: YES
    user_id=919791

    New option 'SkipCompile' added to
    MSDN/MSDN_2003/VS.NET_2003 documenter.

    The latest source can be obtained from
    http://ndoc.sourceforge.net/ndoc-nightly.zip

     
  • Kevin Downs

    Kevin Downs - 2005-03-23
    • assigned_to: nobody --> kdowns
    • status: open --> closed
     

Log in to post a comment.

MongoDB Logo MongoDB