[AstroPy] Mangled reference numbers in spinx documentation for Astropy affiliated package

Juan BC jbc.develop at gmail.com
Thu Apr 26 14:08:28 EDT 2018


This feature (?) solves the problem, if two documentations has the same
reference. for example


1 <http://dpaste.com/0QE8N3D#line-1> 2
<http://dpaste.com/0QE8N3D#line-2> 3
<http://dpaste.com/0QE8N3D#line-3> 4
<http://dpaste.com/0QE8N3D#line-4> 5
<http://dpaste.com/0QE8N3D#line-5> 6
<http://dpaste.com/0QE8N3D#line-6> 7
<http://dpaste.com/0QE8N3D#line-7> 8
<http://dpaste.com/0QE8N3D#line-8> 9
<http://dpaste.com/0QE8N3D#line-9>10
<http://dpaste.com/0QE8N3D#line-10>11
<http://dpaste.com/0QE8N3D#line-11>12
<http://dpaste.com/0QE8N3D#line-12>13
<http://dpaste.com/0QE8N3D#line-13>14
<http://dpaste.com/0QE8N3D#line-14>15
<http://dpaste.com/0QE8N3D#line-15>16
<http://dpaste.com/0QE8N3D#line-16>17
<http://dpaste.com/0QE8N3D#line-17>18
<http://dpaste.com/0QE8N3D#line-18>19
<http://dpaste.com/0QE8N3D#line-19>20
<http://dpaste.com/0QE8N3D#line-20>21
<http://dpaste.com/0QE8N3D#line-21>22
<http://dpaste.com/0QE8N3D#line-22>

def foo():   """foo the faa[something2018]      References
----------      .. [something2018] foo the faa the thing in spam
"""   pass      def foo2():   """foo2 the faa[something2018]
References   ----------      .. [something2018] foo the faa the thing
in spam      """   pass


The two function has the same reference name but sphinx link to they own
reference

On Thu, 26 Apr 2018 at 14:57 Thomas Robitaille <thomas.robitaille at gmail.com>
wrote:

> Hi Leo,
>
> I think this *may* be an issue that would be resolved with the latest
> version of numpydoc.
>
> I need to update the package-template to use the new sphinx-astropy
> infrastructure which allows you to use the latest version of numpydoc.
>
> Cheers,
> Tom
>
>
> On 26 April 2018 at 17:25, Singer, Leo P. (GSFC-6610)
> <leo.p.singer at nasa.gov> wrote:
> > Hi,
> >
> > In the Sphinx documentation for my Astropy-affiliated package, I am
> finding that numbers for references are getting mangle into something that
> looks like a git hash (e.g. "[R23d00ce4ef89-1]"). Here is an example:
> >
> > https://leo-singer.docs.ligo.org/ligo.skymap/ligo/skymap/bayestar.html
> >
> > How do I prevent sphinx from mangling my reference numbers?
> >
> > Thanks,
> > Leo
> >
> >
> > ----
> > Dr. Leo P. Singer
> > NASA Goddard Space Flight Center
> > Astroparticle Physics Laboratory
> > Code 661, 8800 Greenbelt Rd.
> > Greenbelt, MD 20771, U.S.A.
> >
> >
> >
> >
> > _______________________________________________
> > AstroPy mailing list
> > AstroPy at python.org
> > https://mail.python.org/mailman/listinfo/astropy
> _______________________________________________
> AstroPy mailing list
> AstroPy at python.org
> https://mail.python.org/mailman/listinfo/astropy
>
-- 

Juan BC (from phone)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/astropy/attachments/20180426/f48b6a04/attachment.html>


More information about the AstroPy mailing list