Re: [Doxygen-users] difference between readthedocs generated and local

[Ryan S. E. <rel...@um...>]

Hello,

Thanks for the reply.

I tried 1.8.11 on my mac and I get a Segmentation fault!

.
.
.
Reading /Users/relliott/unison-sync/KIM/git/kim-api/fortran/include/kim_model_compute_arguments_module.f90...
Parsing file /Users/relliott/unison-sync/KIM/git/kim-api/fortran/include/kim_model_compute_arguments_module.f90...
/bin/sh: line 1: 54543 Segmentation fault: 11  /Users/relliott/doxygen/build/bin/doxygen /Users/relliott/unison-sync/KIM/git/kim-api/build/docs/Doxyfile.docs


Anyway, then I set up a ubuntu VM and got it to work.  Indeed, 1.8.11 on ubuntu 
it seems I get the same output as RTD.  I've also confirmed that 1.8.14 on 
ubuntu produces the same output (without the interfaces documented) that I 
previously obtained on my mac.


So, it seems that this is a regression in behavior from 1.8.11 to 1.8.14?  How 
should I go about figuring out when/where this happened and what to do about 
it?



On Wed, 30 Jan 2019, Travis Everett wrote:

> The copy on RTD indicates it was generated by doxygen 1.8.11, while the one
> at openkim indicates 1.8.14; a good first step would be installing 1.8.11
> and seeing if your output matches what's on RTD.
>
> On Wed, Jan 30, 2019 at 3:08 PM Ryan S. Elliott <rel...@um...> wrote:
>
>> Hello,
>>
>> I'm working on the doxygen documentation for the kim-api project
>> (https://github.com/openkim/kim-api)
>>
>> When I locally (on my mac) generate the doxygen docs I see problems with
>> the
>> fortran docs.  In particular, there are a fair number of functions that
>> are not
>> automatically documented by the parser.  Further, no generic interfaces are
>> documented.
>>
>> However, the exact same git commit, when used to generate the doxygen docs
>> by
>> readthedocs documents all the functions and generates the generic interface
>> docs.
>>
>> Here is a link to a readthedocs page showing the interfaces:
>> https://kim-api.readthedocs.io/en/latest/namespacekim__model__module.html
>>
>> Here is a link to a similar page generated locally:
>> https://openkim.org/kim-api/docs-beta.3/namespacekim__model__module.html
>>
>> In particular, also notice that in the locally generated docs the
>> "kim_model_is_routine_present" function is not documented!
>>
>>
>> I can't understand why these differences are occuring.  Can anyone point
>> me in
>> the right direction?
>>
>>
>> Thanks,
>>
>> Ryan Elliott
>>
>>
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>

-- 
Ryan S. Elliott, Ph.D. and Professor
Aerospace Engineering & Mechanics, University of Minnesota
(612) 624-2376 (626-1558 fax)
https://z.umn.edu/relliott
download vCard <https://z.umn.edu/relliott_vcf>
----------
The distinction between past, present and future, is only an illusion, even
    if a stubborn one.

                                                            Albert Einstein
----------