2015-05-13 11 views
10

Używanie autodoc i podobnych narzędzi pozwala skompilować dokumentację ze źródła docstrings. To nie wydaje się jednak, aby umożliwić tytuły sekcji dowolna reszta funkcji lub klasy docstrings i tworzy błąd:Sfinks poważne: nieoczekiwany tytuł sekcji - dowolne nagłówki w funkcji docstring w dokumencie

SEVERE: Unexpected section title.

I encoutered podobny problem, gdy próbuje dokumentować zgodnie z wytycznymi NumPy styl bez numpydoc: unexpected section title with sphinx is numpy the issue and how does numpy process docstrings into sphinx documentation for parameters

Tutaj jednak mam faktycznie dokumentowanie JavaScript i po prostu lubią mieć dowolne tytuły sekcji i odpocząć w docstring.

JavaScript docstring api: sphinx jsapidoc

Odpowiedz

0

Tak, wymóg, aby dodać dowolne tytuły sekcji i odpocząć w obrębie docstring mogą stwarzać wyzwania; sphinx-jsapidoc jest skuteczne w przypadku tego wymagania.

Powiązane problemy