在Sphinx中评论Python代码

时间:2012-07-19 07:58:21

标签: python python-sphinx

我正在编写一些Python代码的文档,我无法正确地插入注释。 我在.rst文件中写的内容与生成的html中显示的内容之间存在问题。它看起来像这样:

.rst文件:

.. sourcecode:: python  

    class Foo( argument_1, argument_2 ):           # argument_1 is blabla, arg2 is..

        def bar():                                 # method bar does ...
            print 'foo'                            # another comment

        def foo_bar():                             # foo_bar method explanation
            print 'foo_bar body'                   # ....

在生成的.html文件中,它看起来很好,除了注释是未对齐的:

.html文件:

class Foo( argument_1, argument_2 ):         # argument_1 is blabla, arg2 is..

    def bar():                                  # method bar does ...
        print 'foo'                            # another comment

    def foo_bar():                             # foo_bar method explanation
        print 'foo_bar body'                 # ....

有没有办法解决这个问题?我在Ubuntu 11.04上使用gedit来编写这个文档。我一直在玩标签的宽度,用空格替换标签,但它没有帮助。

0 个答案:

没有答案