Re: [Denemo-devel] Denemo reference with gtkdoc

[Éloi Rivard]

Well, it is not yet written :)

I think I don't get your question. What I picture is a script that:

1 - Get the last stable release from the repository (thanks to the "stable" tag)

2 - Builds the reference

3 - Copy the built files somewhere the webserver can access it.

The script should be launched every day (for instance) by cron.

2013/10/31 Jeremiah Benham <address@hidden>

On Thu, Oct 31, 2013 at 9:11 AM, Éloi Rivard <address@hidden> wrote:

Ok, I found how to make gtk-doc fully optional. This is merged.

Jeremiah is denemo.org just a web hosting or a virtual machine ?

If it is a virtual machin, I can make you a script that regularly checks the repository and builds the reference from the last stable release, and copy it somewhere so it is accessible from the website.
What do you think ?

Its a VM. That sounds good. Is the script controlling something like the mxe build system?

Jeremiah

2013/10/31 Jeremiah Benham <address@hidden>

Gtkdoc and its dependencies are very difficult to compile in gub. As long as denemo can still be built without it, we are ok.

Jeremiah

On Oct 31, 2013 6:07 AM, "Éloi Rivard" <address@hidden> wrote:

Hi,

I have created a gtkdoc branch that creates a html reference of the source code, in the GNOME fashion (See for example https://developer.gnome.org/gtk3/stable/GtkDialog.html).

On .deb systems you will need to install the package "gtk-doc-tools", and then run

./autogen.sh

Reference generation is disabled by default but you can enable it with :

./configure --enable-gtk-doc

Then you can read the reference at docs/reference/denemo/html/index.html

It does not have a lot of information now because the code is mostly uncommented. But this can motive us to comment a bit more. The syntax of the comments used by gtk-doc is very similar to doxygen syntax, and can be read here : https://wiki.gnome.org/DocumentationProject/GtkDoc#Documenting_a_section

The main drawback is that now autogen.sh has a further dependency, that is gtkdoc.

Could you please test and give your thoughts about this ?

--
Éloi Rivard - address@hidden
       
« On perd plus à être indécis qu'à se tromper. »

_______________________________________________
Denemo-devel mailing list
address@hidden
https://lists.gnu.org/mailman/listinfo/denemo-devel

--
Éloi Rivard - address@hidden
       
« On perd plus à être indécis qu'à se tromper. »

--
Éloi Rivard - address@hidden
       
« On perd plus à être indécis qu'à se tromper. »