小编And*_*ier的帖子

Doxygen:如何在所有输出格式的主页上嵌入图像?

我在Ubuntu 14.04上使用Doxygen 1.8.6从C/C++头文件生成API文档.

我有一个标记格式(文件mainpage.md)的主页,并希望将图像(文件logo.png)嵌入该页面.

目前,我有HTML输出,具有以下目录结构:

    work
    ??? mainpage.md
    ??? resources
    ?   ??? logo.png
    ??? html
        ??? index.html

降价mainpage.md嵌入图像的方式是:

![The Logo](../resources/logo.png)
Run Code Online (Sandbox Code Playgroud)

这是有效的,但这取决于HTML输出目录是从工作目录向下一级,而(fwiw)与mainpage.md包含该引用的文件的位置不同步.

我不得不承认我没有尝试其他输出格式会发生什么(目标格式是:HTML,PDF,通过LaTex,手册页,Eclipse帮助),但它们可能与输出目录和图像文件的引用不同.

我的问题是:

  1. 上述其他输出格式是否适用于此降价参考?

  2. 是否有更多的输出格式不可知的方式从主页面降价引用图像文件?

安迪

html markdown doxygen image

7
推荐指数
1
解决办法
1万
查看次数

如何使用 Sphinx 创建 (#) 样式的编号列表

Sphinx 引用的 RST 文档为“权威的 reStructuredText 用户文档”(请参见此处),显示了编号列表格式的几种样式,其中包括括号样式(请参见此处):

(1) foo
(2) bla
Run Code Online (Sandbox Code Playgroud)

然而,Sphinx 会从这样的 RST 源生成带有点的样式:

1. foo
2. bla
Run Code Online (Sandbox Code Playgroud)

Sphinx 文档仅显示点线样式(请参阅此处)。

我的问题是:有什么方法可以让 Sphinx 创建数字的括号样式吗?

restructuredtext python-sphinx

7
推荐指数
1
解决办法
1万
查看次数

Doxygen:描述中的 C typedef 名称不会成为链接

我在 C 头文件上使用 Doxygen,并且很难将描述文本中出现的 typedef 名称变成指向相应 typedef 定义的链接。这适用于结构,但不适用于 typedef。

例子:

struct _my_s1;

/** Description for typedef my_s1. */
typedef struct _my_s1 my_s1;

struct _my_s2;

/** Description for typedef my_s2. */
typedef struct _my_s2 my_s2;

/**
 * @brief Structure _my_s1
 */
struct _my_s1 {

    my_s2 * s2t; ///< pointer to my_s2

    struct _my_s2 * s2s; ///< pointer to struct _my_s2

    /**
     * @brief Function f2t
     * @param s2t A pointer to my_s2.
     * @return An integer.
     */
    int (*f2t)(my_s2* s2t);

    /** …
Run Code Online (Sandbox Code Playgroud)

c struct typedef doxygen hyperlink

5
推荐指数
0
解决办法
982
查看次数

Sphinx:如何链接到不同项目术语表中的术语

我确实了解如何在 Sphinx RST 中创建术语表,以及如何链接到其术语:

.. glossary::

   term1
      description of term1

Linking to :term:`term1` is easy.
Run Code Online (Sandbox Code Playgroud)

我的问题是,如何链接到不同 Sphinx 项目词汇表中的术语(我有一个 intersphinx 定义)?

例如,我对 Python 2 的 Sphinx 文档有一个 intersphinx 定义:

intersphinx_mapping = {
  'py': ('https://docs.python.org/2/', None),
}
Run Code Online (Sandbox Code Playgroud)

但我未能成功指定其词汇表术语之一的链接,使用 RST 源中的任何这些结构:

:ref:`py:iterable`
:ref:`py:glossary.iterable`
:term:`py:iterable`
:term:`py:glossary.iterable`
Run Code Online (Sandbox Code Playgroud)

这可能吗?如果可能的话,词汇表的定义需要是什么样子,以及对词汇表术语的引用如何?

python glossary restructuredtext python-sphinx

5
推荐指数
0
解决办法
1397
查看次数

如何从 bash shell 中找到 MSYS2 的版本

我想从 bash shell 中找出当前正在运行的 MSYS2 版本。

例如,是否有一个类似于Windows“ver”的命令,或者表示整个MSYS2安装的特定包?

以防万一,我正在使用 MSYS2 的 MSYS 子系统。

msys2

5
推荐指数
2
解决办法
6035
查看次数