Leggi Leggi Docs include la documentazione dell'autodoc per i membri speciali?

Question

Ho un modulo con due membri speciali globali documentati.

Running Sphinx localmente crea documentazione che include i loro documenti, ma Read the Docs no. Usa invece la documentazione del tipo integrato.

Ho provato entrambi gli stili: #: e docstring dopo la definizione. Ho letto la documentazione di autodoc più volte e lo . Non riesco a capire cosa mi manca, poiché non vedo errori di compilazione in Read the Docs.

Qualche idea?

Answer 1

Nel caso in cui si utilizza l'estensione Napoleone per gestire NumPy o Google docstrings stile, è possibile impostare un flag di configurazione per questo nella vostra conf.py

http://sphinx-doc.org/ext/napoleon.html?highlight=special#confval-napoleon_include_special_with_doc

Se non ricordo male c'è anche una direttiva per autodoc:

http://sphinx-doc.org/ext/autodoc.html?highlight=member#event-autodoc-skip-member

con l'attuazione di questo metodo si ha una bella scelta grana dei quali membro sta per essere inclusi nella documentazione e che non lo è.