使用 Cornice 的 Sphinx 集成记录 Cornice 的资源

Question

我有一个Pyramid application with Cornice package where I defined Resources (rather than Services) and I wonder if it is possible to generate Sphinx documentation for this project with a help of Cornice's Sphinx integration?

我设法生成了某种文档，但似乎大部分功能不适用于资源，仅适用于服务，例如，以这种方式记录 Pyramid 代码：

@resource(collection_path='/parse/', path='/parse/{id}', cors_origins=('*',), description="Temporary description.")
class Parser(object):

    @view(renderer='json')
    def collection_post(self):
        """
        Some description for this function...
        :param str smth: Some parameter
        :return: Returns something
        """
        return

并像这样构建 Sphinx 文档：

.. cornice-autodoc::
   :modules: my_app.views.views_parser
   :ignore: parser

将导致文档中几乎没有不必要的和遗漏的部分：

服务名称（实际上是资源名称）乱七八糟，
函数collection_post本身没有记录，
无需记录 resource 声明中的 collection_path 和 path）：

_{^{（来自生成文档的示例片段）}}

Collection_Parser 服务位于 /parse/

临时说明。

POST

响应：json

解析器服务位于 /parse/{id}

临时说明。

我想知道的是：

如何更改文档中生成的名称（Parser 而不是 Collection_Parser），
如何 'ignore' 一些带有 :ignore: 语句的模块（例如，我不想记录 /parse/{id} 部分），
如何在资源中记录函数，因为放置注释块只是被忽略（collection_post 在我的例子中）

...还有很多其他的...
这似乎是不可能的，或者根本没有记录。如果情况是这是不可能的，是否有任何其他（至少是半自动化的）解决方案来记录我的项目？

Answer 1

这似乎是不可能的，因为 Cornice 不支持这种功能(https://github.com/mozilla-services/cornice/issues/279)...

使用 Cornice 的 Sphinx 集成记录 Cornice 的资源

Documenting Cornice's Resources with Cornice's Sphinx integration

python

pyramid

python-sphinx

documentation-generation

cornice

Collection_Parser 服务位于 /parse/

POST

解析器服务位于 /parse/{id}