search

sbrisard / janus

Discretization of the Lippmann--Schwinger equation with periodic boundary conditions
BSD 3-Clause "New" or "Revised" License
9 stars 3 forks source link

[Documentation] Compilation issues on RTD #21

Closed sbrisard closed 4 years ago

sbrisard commented 6 years ago

On Read the docs, autodoc does not work correctly with cython modules .

The solution is to produce the *.rst files of the API locally, and push these files to GitHub. This can be done by capturing the following sphinx events: autodoc-process-signature, autodoc-process-docstring.

However, these events are raised before the docstrings are parsed by the napoleon extension. The first step is therefore to get rid of napoleon and the Google style for docstring. I prefer a more verbose doc style anyway (like the Python standard library).

sbrisard commented 4 years ago

Issue closed as the docs are moved to GitHub Pages.