Jak mogę używać rozszerzenia Autodoc Sphinx do prywatnych metod?

Question

Używam Sphinx do dokumentowania mojego projektu Pythona. Mam włączone rozszerzenie autodoc i mam w moich dokumentach następujące elementy.

.. autoclass:: ClassName 
    :members: 

Problem polega tylko na tym, że dokumentuje tylko klasę non-private methods. Jak również uwzględnić prywatne metody?

Answer 1

Czy próbowałeś użyć custom method do określenia, czy członek powinien zostać włączony do dokumentacji, używając autodoc-skip-member?

Answer 2

Oto podpowiedź: wyobraź sobie, że prywatne oznacza "tajne".

Dlatego Sphinx ich nie udokumentuje.

Jeśli nie masz na myśli "tajemnicy", rozważ zmianę ich nazw. Unikaj używania nazwy pojedynczego znaku wiodącego podkreślenia w ogóle; to nie pomaga, chyba że masz powód, aby utrzymywać implementację w tajemnicy.

Answer 3

Nie, prywatnych środków prywatnych do klasy i że nie powinien być stosowany z publicznych API. Nie oznacza to tajemnicy i dla tych z nas, którzy chcą używać sfinksa do pełnej dokumentacji zajęć, z wyłączeniem metod prywatnych jest dość denerwujące.

Poprzednia odpowiedź jest prawidłowa. Będziesz musiał użyć niestandardowej metody, ponieważ Sphinx nie obsługuje obecnie autodoc w połączeniu z prywatnymi metodami.

Answer 4

Jednym ze sposobów, aby ominąć ten jest jawnie wymusić Sphinx udokumentować członków prywatnych. Można to zrobić poprzez dołączenie automethod do końca docs poziomie klasy:

class SmokeMonster(object): 
    """ 
    A large smoke monster that protects the island. 
    """ 
    def __init__(self,speed): 
     """ 
     :param speed: Velocity in MPH of the smoke monster 
     :type speed: int 

     .. document private functions 
     .. automethod:: _evaporate 
     """ 
     self.speed = speed 

    def _evaporate(self): 
     """ 
     Removes the smoke monster from reality. Not to be called by client. 
     """ 
     pass 

Answer 5

jeśli używasz sfinks 1.1 lub wyżej, od strony dokumentacji Sfinks w http://sphinx.pocoo.org/ext/autodoc.html,

:special-members: 
:private-members: 

Answer 6

Patrząc na apidoc code , możemy zmienić to, co sfinks-apidoc generuje ustawienie zmiennej środowiskowej:

export SPHINX_APIDOC_OPTIONS='members,special-members,private-members,undoc-members,show-inheritance' 

Możesz również dodać tę konfigurację do pliku Makefile (i f pakiet korzysta jeden):

docs: 
    rm -rf docs/api 
    SPHINX_APIDOC_OPTIONS='members,special-members,private-members,undoc-members,show-inheritance' sphinx-apidoc -o docs/api/ intellprice 
    $(MAKE) -C docs clean 
    $(MAKE) -C docs html 

Answer 7

Można dodać do tego pliku: conf.py

autodoc_default_flags = ['members', 'undoc-members', 'private-members', 'special-members', 'inherited-members', 'show-inheritance']