| Re: How to exclude a directory for idldoc? [message #81509] |
Sat, 29 September 2012 10:00 |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On 9/28/12 8:28 PM, SonicKenking wrote:
> Hi Mike, thanks for the reply. It worked for the directory. However
> it does not work recursively into the sub-directories. Do I have to
> put the .idldoc into every sub-directory or is there an easy way?
There is not recursive option; you have to put an .idldoc file into
every subdirectory.
> Is the usage of ".idldoc" file documented anywhere? I remember once I
> downloaded a PDF version documentation of IDLdoc. That is where I
> learned the usage of "overview" and "footer" files. I cannot find the
> file anymore and it does not seem to be available on the website
> (http://idldoc.idldev.com/). I wonder if I can find the usage of the
> .idldoc file in that file. I also tried "make book" with the idldoc
> source. But it failed with the message " LaTeX Error: File
> `xifthen.sty' not found ". Any suggestions?
There is a docs/ subdirectory in the IDLdoc distribution with PDFs of a
tutorial and reference guide. The reference guide has a description of
the tags allowed in directory overview files, but doesn't give much of
an overview what exactly a "directory overview file" is or even to name
it ".idldoc". Will add to the docs.
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation
|
|
|
|
| Re: How to exclude a directory for idldoc? [message #81515 is a reply to message #81509] |
Fri, 28 September 2012 19:28  |
SonicKenking
Messages: 51
Registered: October 2010
|
Member |
|
|
Hi
On Saturday, September 29, 2012 1:08:40 AM UTC+10, Mike Galloy wrote:
> On 9/27/12 6:28 PM, SonicKenking wrote:
>
>> Is there a way in the settings to let user exclude certain directories for generating the documentations?
>
>>
>
>> For example, I have an "obsolete" directory which contains old programs. I'd like to exclude them from being shown in the documentations.
>
>>
>
>> I am using idldoc 3.4.3.
>
>>
>
>
>
> Yes, place an .idldoc file in the directory to be hidden and put a
>
> Hidden tag in that file. For example, if you using rst style docs, all
>
> the file has to contain is:
>
>
>
> :Hidden:
>
>
>
> Mike
>
> --
>
> Michael Galloy
>
> www.michaelgalloy.com
>
> Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
>
> Research Mathematician
>
> Tech-X Corporation
Hi Mike, thanks for the reply. It worked for the directory. However it does not work recursively into the sub-directories. Do I have to put the .idldoc into every sub-directory or is there an easy way?
Is the usage of ".idldoc" file documented anywhere? I remember once I downloaded a PDF version documentation of IDLdoc. That is where I learned the usage of "overview" and "footer" files. I cannot find the file anymore and it does not seem to be available on the website (http://idldoc.idldev.com/). I wonder if I can find the usage of the .idldoc file in that file. I also tried "make book" with the idldoc source. But it failed with the message " LaTeX Error: File `xifthen.sty' not found ". Any suggestions?
|
|
|
|
| Re: How to exclude a directory for idldoc? [message #81520 is a reply to message #81515] |
Fri, 28 September 2012 08:08 |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On 9/27/12 6:28 PM, SonicKenking wrote:
> Is there a way in the settings to let user exclude certain directories for generating the documentations?
>
> For example, I have an "obsolete" directory which contains old programs. I'd like to exclude them from being shown in the documentations.
>
> I am using idldoc 3.4.3.
>
Yes, place an .idldoc file in the directory to be hidden and put a
Hidden tag in that file. For example, if you using rst style docs, all
the file has to contain is:
:Hidden:
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
