reStructuredText (and Sphinx) can't link to external file by using :ref: or :doc:.
:ref: links to label (reST notation). :doc: links to sphinx document source that is parsed by sphinx. In your case, test1.pdf is not a 'label' nor 'document source'. If you want to link to local file, it is meaning less because other document users can't access your filesystem. Please put your test1.pdf file on some http reachable location and write the URL to your reST file. If you want to contain test1.pdf into your HTML output, you can use :download:`test1.pdf` notation. It will work for HTML output. Regards, -- Takayuki Shimizukawa 2015/11/18 16:33 Dave Dittrich <[email protected]>: > OK, now I need to link to external docs (PDF, in this case), but I can't > figure out from the link you show above where is the root of the relative > path specified. For example, if I use ":doc:test1.pdf", does it expect to > find the file in source/test1.pdf, source/_static/test1.pdf, > source/../test1.pdf, or somewhere else? Every time sphinx-autobuild renders > the doc it complains it can't find the file, but it gives me no concept of > where it is trying to find it. > > Even if I put the file in /tmp and use :doc:`/tmp/test1.pdf` it can't find > it. > > None:None: WARNING: unknown document: test1.pdf > > What am I doing wrong? > > /path/to/source/results.rst:163: WARNING: unknown document: /tmp/test1.pdf > > $ grep test1.pdf /path/to/source/results.rst > integration expected_value automated_test :ref:`diutUserStory6` > :doc:`/tmp/test1.pdf` > > $ file /tmp/test1.pdf > /tmp/test1.pdf: PDF document, version 1.4 > > Or is the error message just not explicit enough and it is some other > problem (like can't link to a PDF?) > > If the latter, what should I do to include external files by links into a > table in a ReST document that is generated programmatically? > > Thanks! > > Dave > > > On Sun, Nov 8, 2015 at 7:48 PM, Takayuki Shimizukawa < > [email protected]> wrote: > >> Hi, >> >> Use :doc:`intro/00_setup` instead of :ref:. >> >> :ref: links to label. >> :doc: links to file. >> >> Please refer: >> http://sphinx-doc.org/markup/inline.html#role-ref >> http://sphinx-doc.org/markup/inline.html#role-doc >> >> -- >> Takayuki SHIMIZUKAWA >> http://about.me/shimizukawa >> >> 2015年11月9日(月) 7:35 Alex Little <[email protected]>: >> >>> Hi all, >>> >>> I'm relatively new to using Sphinx Docs - and I'm a little stuck with >>> something I'm attempting to do... >>> >>> What I'd like is to have a table, where the entries in the cells in the >>> first column refer to another doc page. >>> >>> What I've tried so far is: >>> >>> .. table:: >>> >>> ======================== =============== ===================== >>> Session Time Notes >>> ======================== =============== ===================== >>> :ref:`intro/00_setup` 1 hour Yes >>> ======================== =============== ===================== >>> >>> and: >>> >>> +------------------------+------------+----------+ >>> | Session | Time | Notes | >>> +========================+============+==========+ >>> | :ref:`intro/00_setup` | 1 hour | Yes | >>> +------------------------+------------+----------+ >>> >>> However neither of these turn the :ref: part into an actual link to the >>> doc page (it simply outputs 'intro/00_setup'). I realise that this is quite >>> similar to a toctree - but I'd really like to also show the time and notes >>> (hence the table format rather than a simple list), that toctree doesn't >>> seem to allow me to do. >>> >>> Any help or other options/approaches for how I could achieve this is >>> very much appreciated. Also quite likely is that I have a misunderstanding >>> or I've missed something obvious. >>> >>> Cheers, >>> Alex >>> >>> -- >>> You received this message because you are subscribed to the Google >>> Groups "sphinx-users" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to [email protected]. >>> To post to this group, send email to [email protected]. >>> Visit this group at http://groups.google.com/group/sphinx-users. >>> For more options, visit https://groups.google.com/d/optout. >>> >> -- >> You received this message because you are subscribed to the Google Groups >> "sphinx-users" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to [email protected]. >> To post to this group, send email to [email protected]. >> Visit this group at http://groups.google.com/group/sphinx-users. >> For more options, visit https://groups.google.com/d/optout. >> > > > > -- > Dave Dittrich > [email protected] > > -- > You received this message because you are subscribed to the Google Groups > "sphinx-users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To post to this group, send email to [email protected]. > Visit this group at http://groups.google.com/group/sphinx-users. > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
