Re: Resolving cross-references among components

[Stefan Sauer <ensonic hora-obscura de>]

On 11/18/2012 12:12 AM, David Nečas wrote:
> Hello, what is the recommended method/best practice for getting right
> bidirectional cross-references in documentation?
>
> Imagine a project that builds two libraries, libA and libB, with
> separate documentation.  If documentation for libA is built while
> index.sgml in libB documentation does not exist yet, cross-links from A
> to B will not resolve.  And vice versa.  Even if B strictly depends on A
> one may want to reference B from the documentation of A to point out
> implementations of abstractions, more high-level facilities or other
> code in B that builds on A's features.
>
> Since index.sgml is distributed anyone who rebuilds the documentation
> from a tarball will get cross-references both ways right.  But what
> about fresh checkouts?  I can only think of two ways to get correct
> cross-references, one uglier than the other:
> - build documentation twice
> - keep index.sgml in the version control system
I can't add anything here. Do you have a case where this happens? I
would probably build twice as checking in generated files lead to all
sort of hassle :/
>
> Yeti
>
> _______________________________________________
> gtk-doc-list mailing list
> gtk-doc-list gnome org
> https://mail.gnome.org/mailman/listinfo/gtk-doc-list

Stefan