Как проанализировать строки документов keras в Sphinx при наследовании их с помощью autodoc - PullRequest
Новая
       8

Как проанализировать строки документов keras в Sphinx при наследовании их с помощью autodoc

0 голосов
/ 03 января 2019

Я создаю пакет, в котором используются классы keras.
Я создаю свою документацию с помощью Sphinx, используя соглашение о документации Google с наполеоном для его анализа.

Некоторые из моих методов переопределяют методы keras ине задокументировано, поэтому автодок Sphinx наследует строки документации от исходного переопределенного метода в keras.

К сожалению, документация в keras не соответствует ни Google, ни numpy, ни соглашению о rest docstring.Это своего рода соглашение Google с символами '#' от markdown, я думаю, вот пример: 

def keras_doc_example(inputs, **kwargs):
  """
  # Arguments
        inputs: Can be a tensor or list/tuple of tensors.
        **kwargs: Additional keyword arguments.

  # Returns
        An output.
  """

Поэтому, когда я собираю свою документацию, вся документация из строк документации keras выглядит испорченной из-за нераспознанного '#'символы.

Как правильно проанализировать это соглашение о документах keras?

...