[gmx-users] generating Doxygen documentation

[Michele Pellegrino]

Paul,

thank you very much!

Cheers,
Michele
________________________________________
From: gromacs.org_gmx-users-bounces at maillist.sys.kth.se <gromacs.org_gmx-users-bounces at maillist.sys.kth.se> on behalf of Paul Bauer <paul.bauer.q at gmail.com>
Sent: 12 February 2020 21:02
To: gmx-users at gromacs.org
Subject: Re: [gmx-users] generating Doxygen documentation

The correct address is
http://jenkins.gromacs.org/job/Documentation_Nightly_master/javadoc/doxygen/html-full/index.xhtml

Need to fix a link somewhere then I think.

/Paul

On Wed, 12 Feb 2020, 20:46 Michele Pellegrino, <micpel at kth.se> wrote:

> Moreover: the link to Jenkins does not work (section 7.8.1, "Building the
> documentation"):
>
>
> http://jenkins.gromacs.org/job/Documentation_Nightly_master/javadoc/html-lib/index.xhtml
>
> Cheers,
> Michele
> ________________________________________
> From: gromacs.org_gmx-users-bounces at maillist.sys.kth.se <
> gromacs.org_gmx-users-bounces at maillist.sys.kth.se> on behalf of Michele
> Pellegrino <micpel at kth.se>
> Sent: 12 February 2020 20:39
> To: gmx-users at gromacs.org
> Subject: Re: [gmx-users] generating Doxygen documentation
>
> Mark,
>
> no such directory is produced after make (evein if the output is 'Built
> target doxygen-all').
> The only Doxyfile I can utilize to generate html/latex documentation is
> 'Doxyfile-compact', while all others are still 'Doxyfile-*.cmakein'.
>
> It seems I need to run cmake somewhere, somehow, but it's not really clear
> to me in which directory (and with which options(s)).
>
> Cheers,
> Michele
> ________________________________________
> From: gromacs.org_gmx-users-bounces at maillist.sys.kth.se <
> gromacs.org_gmx-users-bounces at maillist.sys.kth.se> on behalf of Mark
> Abraham <mark.j.abraham at gmail.com>
> Sent: 12 February 2020 17:34
> To: Discussion list for GROMACS users
> Subject: Re: [gmx-users] generating Doxygen documentation
>
> Hi,
>
> When they succeed, the doxygen targets produce files like
>
> $builddir/docs/html/doxygen/html-*/index.xhtml
>
> which you can open in your browser. The doxygen for the released versions
> is on the web however, so it's much easier to just use or refer to that.
>
> Mark
>
> On Wed, 12 Feb 2020 at 16:30, Michele Pellegrino <micpel at kth.se> wrote:
>
> > Hi,
> >
> >
> > I am trying to generate the Doxygen documentation for GROMACS from the
> > files in /docs/doxygen.
> >
> > I following 2020 manual, I run 'make doxygen-all' in the build directory,
> > succesfully; I don't know what to do next: I tried to run cmake in the
> > doxygen directory to generate the Doxyfiles, but I get the following
> errors:
> >
> > """
> >
> > CMake Error at CMakeLists.txt:36 (include):
> >   include could not find load file:
> >
> >     gmxCustomCommandUtilities
> >
> >
> > CMake Error at CMakeLists.txt:37 (include):
> >   include could not find load file:
> >
> >     gmxOptionUtilities
> >
> >
> > CMake Error at CMakeLists.txt:53 (gmx_dependent_option):
> >   Unknown CMake command "gmx_dependent_option".
> >
> > """
> >
> > What should I do?
> >
> >
> > Thanks for your attention,
> >
> > Michele
> >
> >
> > p.s. I am referring to the github master branch current version
> > --
> > Gromacs Users mailing list
> >
> > * Please search the archive at
> > http://www.gromacs.org/Support/Mailing_Lists/GMX-Users_List before
> > posting!
> >
> > * Can't post? Read http://www.gromacs.org/Support/Mailing_Lists
> >
> > * For (un)subscribe requests visit
> > https://maillist.sys.kth.se/mailman/listinfo/gromacs.org_gmx-users or
> > send a mail to gmx-users-request at gromacs.org.
> >
> --
> Gromacs Users mailing list
>
> * Please search the archive at
> http://www.gromacs.org/Support/Mailing_Lists/GMX-Users_List before
> posting!
>
> * Can't post? Read http://www.gromacs.org/Support/Mailing_Lists
>
> * For (un)subscribe requests visit
> https://maillist.sys.kth.se/mailman/listinfo/gromacs.org_gmx-users or
> send a mail to gmx-users-request at gromacs.org.
> --
> Gromacs Users mailing list
>
> * Please search the archive at
> http://www.gromacs.org/Support/Mailing_Lists/GMX-Users_List before
> posting!
>
> * Can't post? Read http://www.gromacs.org/Support/Mailing_Lists
>
> * For (un)subscribe requests visit
> https://maillist.sys.kth.se/mailman/listinfo/gromacs.org_gmx-users or
> send a mail to gmx-users-request at gromacs.org.
> --
> Gromacs Users mailing list
>
> * Please search the archive at
> http://www.gromacs.org/Support/Mailing_Lists/GMX-Users_List before
> posting!
>
> * Can't post? Read http://www.gromacs.org/Support/Mailing_Lists
>
> * For (un)subscribe requests visit
> https://maillist.sys.kth.se/mailman/listinfo/gromacs.org_gmx-users or
> send a mail to gmx-users-request at gromacs.org.
>
--
Gromacs Users mailing list

* Please search the archive at http://www.gromacs.org/Support/Mailing_Lists/GMX-Users_List before posting!

* Can't post? Read http://www.gromacs.org/Support/Mailing_Lists

* For (un)subscribe requests visit
https://maillist.sys.kth.se/mailman/listinfo/gromacs.org_gmx-users or send a mail to gmx-users-request at gromacs.org.