2014-03-13 64 views
6

我正在为我们的一个硬件产品制作一些项目文档。该文档是供内部使用,并且它位于网络驱动器上:如何链接到Sphinx网络驱动器上的a:download:文件?

\\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

该文档托管在网络上,但是您是否通过网络上的狮身人面像来构建它?使用: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并通过狮身人面像创建一个pdf文件来启动它。你可以使用.. raw :: latex指令。

.. raw:: latex 

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

还可以建立自定义指令以使其更加流畅。

相关问题