Skip to content

Sketch of the Documentation for pyPhase

Diogo Figueirinhas requested to merge Documentation into develop

First Documentation Layout

This is a sketch for pyPhase's documentation. It is ready to be build with Sphinx 2.1.2, and integrated with readthedocs.

It uses the Napoleon extension for the auto-documentation, and is set for Numpy style docstrings.

All documentation files but the readme.txt, which is in the root, are under a directory named docs.

This is a sketch of the Documentation. I have included the following pages:

  • Front Page (=readme)
  • About
  • Install direction
  • Examples
  • API reference

Merge request reports