В настоящее время пытаюсь создать некоторую документацию для моего кода, используя Sphinx, и, хотя параметры и типы корректно форматируются, return и rtypes из моей строки документации не являются.
Кто-нибудь знает, что вызвало это?
Строка документации для параметров и возвратов:
:param config: The dictionary object config, created by config_builder (based on a source_directory)
:type config: class 'dict'
:return final_sentence_df: A DataFrame object containing each sentence the author wrote, and in what book they wrote it.
:rtype final_sentence_df: class 'pandas.core.frame.DataFrame'
:return final_word_df: A DataFrame object containing each word an author used, the total words the author used, and the normalised ratio of that word against all words used by the author for comparison against other authors.
:rtype final_word_df: class 'pandas.core.frame.DataFrame'
HTML вывод:
Я уже нашел подобный вопрос здесь, но Похоже, решения не было, и поскольку я новичок в StackOverflow, я не мог это комментировать. : Тип возврата для строки документации
На следующем изображении содержится файл RST, который Sphinx использует для создания документации из кода.
Настройка файла RST