如何链接到:下载:Sphinx中的网络驱动器上的文件?

时间:2014-03-13 20:08:59

标签: hyperlink python-sphinx restructuredtext

我正在为我们的某个硬件产品制作一些项目文档。该文档供内部使用,它位于网络驱动器上:

\\ourserver\projects\project1-doc

我们目前进行版本控制的方式,我们有一些像这样的文件夹:

\\ourserver\projects\project1-A
\\ourserver\projects\project1-B
\\ourserver\projects\project1-C

我希望能够将文档中的:download:链接转换为其中一个文件夹中的pdf。有什么方法可以做到文件的绝对路径吗?我尝试了很多东西,例如:

:download:`schematic <file://///ourserver/projects/project1-C/schematic.pdf>`
:download:`schematic //ourserver/projects/project1-C/schematic.pdf>`

但我无法与Sphinx合作。如何链接到此文件?

1 个答案:

答案 0 :(得分:1)

该文档托管在网络上,但您是通过网络上的sphinx构建的吗?当使用:download:指令sphinx将文件复制到_downloads下的_build / html目录并在那里链接到它们。因此,如果您要在本地构建sphinx文档,并且它无法在构建期间找到要复制和链接的正确文件,那么它将不会创建链接,如果路径错误则相同。

无论如何,由于您链接到版本控制下的文件,您可能希望使用.. raw ::指令创建一个绝对路径,以便始终链接到最新版本。

.. raw:: html

   <p><a class="reference download internal" href="/ourserver/projects/project1-C/schematic.pdf">
   <tt class="xref download docutils literal">
   Project 1-C Schematic
   </tt></a><p>

如果您想链接到pdf并通过sphinx创建的pdf启动它。你可以使用.. raw :: latex指令。

.. raw:: latex

   \href{run:/ourserver/projects/project1-C/schematic.pdf}{Project 1-C Schematic}

也可以构建自定义指令以使其更流畅。