2013-12-10 20 views
6

Chciałbym sfinks wygenerować przegląd modułu podobną do tej wytwarzanej przez doxygen, tutaj jest examplesfinks generować zestawienia moduły klasy

nie mogę znaleźć jak sfinks można zrobić

mogłem użyj Graphviz do wygenerowania jakiegoś wykresu, ale nie mogę znaleźć sposobu na kliknięcie obiektu na wykresie, który działa w taki sam sposób, jak w powyższym przykładzie.

Czy istnieje sposób, aby to zrobić w sfinksie bezpośrednio lub jakiś hack, aby działał jak przegląd modułu doxygen?

Odpowiedz

9

Sphinx ma wbudowany extension o nazwie sphinx.ext.inheritance_diagram, który używa Graphviz. Definiuje jedną dyrektywę: inheritance-diagram. Oto przykład, jak można użyć go w pliku .rst:

.. inheritance-diagram:: mymodule.MyClass1 mymodule.MyClass2 
    :parts: 1 

Oto niektóre przykłady schematów dziedziczenia w dokumentach generowanych przez Sfinksa:


Istnieje również "rodzajowy"Rozszerzeniedo osadzania wykresów w dokumentacji.