-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Am 22.02.2010 13:35, schrieb Daniele Varrazzo: > On Feb 21, 9:27 pm, Georg Brandl <[email protected]> wrote: >> Am 10.02.2010 15:01, schrieb Daniele Varrazzo: > >> >>From Sphinx documentation [1] I read that i can refer to methods in >> > the same class using the :meth: role without specifying the class >> > name. [...] >> >> > I tried to use the feature, but no link is created: [...] > >> Turns out that this is because there is no current module set. Add >> >> .. currentmodule:: whatever >> >> before the class directive and it should work. (I'll still investigate >> that bug.) > > Yes, eventually I reduced the problem until I discovered that it was > the lack of a module to create the issue. Unfortunately those objects > don't really "live" in a module to be referred into (of course there > is an implementation module, but it is an unexposed detail: you > probably know the DBAPI and the fact that connection and cursor > objects don't have an exposed constructor, but are only created via > factory functions). So I've left things as they were and used > `~class.method` (at time of writing I still didn't know the ~ syntax: > the output is exactly what I wanted and I can live with the small > extra typing).
Very good! >> > Shouldn't a warning be issued when using cross reference rules and the >> > target object is not found? >> >> No -- at least not for Python objects, by default. Often times objects >> are referenced that are not documented, or not documented well, etc. >> [...] >> However, I can imagine switching on a mode where these warnings are >> emitted with a flag. > > I guess it wouldn't be bad to have on request a list broken references > to check if any of them is a typo. I don't know if docutils allows > logging priority: in this case this may be a low priority issue. OK, I'll add such a mode for 1.0 or 1.1. > Sorry for not updating the thread, but my first message took several > day before getting approved in the group. Thank you very much for your > work: the documentation produced is really top quality. Thanks! And don't worry, as you can see I myself can only be active mostly on weekends. Georg -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.14 (GNU/Linux) iEYEARECAAYFAkuJngEACgkQN9GcIYhpnLA5eQCcDsTu3GgqKJ2VIDoPbn/KlW8l JosAoIS75e6ZtfwSh1ZuEaeCRE4P4zZe =2Q7c -----END PGP SIGNATURE----- -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
