代码之家  ›  专栏  ›  技术社区  ›  Ilya

斯芬克斯别名支持(替换?)

  •  0
  • Ilya  · 技术社区  · 5 年前

    我正在考虑将我的文档从Doxygen移到Sphinx,并为doxygenalias寻找一个替代方案。

       table_row2{2}=<tr><td align= center>\1</td><td align= center>\2</td></tr> 
    

     limited_res{1}=The number of supported \1 depends on the specific platform. See the \ref appendixes section" 
    

    它可用于以下文档:

    ...
    table_h2{ Resource Name, Value }  
    table_row2{ MAC Entries , 256}
    table_row2{ Ingress Flow , \limited_res { Ingress Flow } }
    ...
    

    我在Sphinx中发现的最接近的东西是替换,但是我很难让它工作,即使是对于下面这样的简单命令替换:

    .. |H1| replace:: `*****************************************************`
    
    My section
    |H1|
    

    H1要么不编译要么只打印“*…*”。

    我不确定这是一个语法问题还是不能做到。我试图避免记住*/+/-/=中的哪个表示什么,并根据嵌套的级别来命名它。我这几天记性不太好:)

    我可以考虑的另一个选择是编写如下扩展 this

    1 回复  |  直到 4 年前
        1
  •  0
  •   Steve Piercy    5 年前

    要使星号显示在“我的分区”下面,您需要至少有一个空格行将“我的分区”与“| H1 |”分隔开。Sphinx/docutils中的空格有意义,分隔的内容被解释为两个段落,而不是内联文本。

    .. |H1| replace:: `*****************************************************`
    
    My section
    
    |H1|
    

    要显示反斜杠,请使用反斜杠字符对其进行转义 \ .

    .. |H1| replace:: \`*****************************************************\`
    
    My section
    
    |H1|
    

    raw directive .

    编辑

    section

    My section
    ==========
    

    如上文所述,两个段落之间的空行将生成段落。