search

NRL-Plasma-Physics-Division / turbopy

A lightweight computational physics framework, based on the organization of turboWAVE. Implements a "Simulation, PhysicsModule, ComputeTool, Diagnostic" class hierarchy.
https://turbopy.readthedocs.io/
Creative Commons Zero v1.0 Universal
10 stars 18 forks source link

Fix sphinx import of numpydoc extension #142

Open arichar6 opened 4 years ago

arichar6 commented 4 years ago

We are using the numpydoc style for our docstrings. All the instructions that I could find seem to say we should be using the numpydoc extension for sphinx.

However, for some reason that I can't remember, using this extension with the automatic documentation generation at ReadTheDocs did not seem to work. Thus this comment: https://github.com/NRL-Plasma-Physics-Division/turbopy/blob/67f913c95ea663ce9d460e8fbeb69395716f437a/docs/conf.py#L41

We should fix this, so that

  1. we can import the numpydoc extension
  2. the documentation is still correctly generated at ReadTheDocs

If this can't be done, I'd like to document why.