python - instalar - ¿Make Read the Docs incluye documentación de autodoc para miembros especiales?

python y word

Question

Tengo un módulo con dos miembros especiales documentados a nivel mundial.

Ejecutar Sphinx localmente crea documentación que incluye sus documentos, pero Read the Docs no. En su lugar, utiliza la documentación del tipo incorporado.

He intentado ambos estilos: #: y docstring después de la definición. He leído la documentación de autodoc varias veces y en la entrada Leer los documentos . No puedo entender lo que me estoy perdiendo, ya que ni siquiera veo ningún error de compilación en Leer los documentos.

¿Algunas ideas?

Answer 1

En caso de que esté utilizando la extensión Napoleon para manejar las cadenas de documentos de estilo NumPy o Google, puede establecer un indicador de configuración para esto en su conf.py

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

Si recuerdo correctamente también hay una directiva para autodoc:

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

Al implementar este método, tiene la opción de elegir qué miembro se incluirá en los documentos y cuál no.