search

tcrundall / chronostar-tng

Chronostar, the next generation of discovery and characterisation of stellar associations
MIT License
0 stars 0 forks source link

Add sphinx docs and docstrings #10

Closed tcrundall closed 2 years ago

tcrundall commented 2 years ago

Docstrings needed for:

tcrundall commented 2 years ago

Add documentation to code and set up automatic sphinx docs generation.

tcrundall commented 2 years ago

Progress made. Using autoDoc vscode extension to autogen docstrings. Using sphinx, specifically sphinx-apidoc to build api docs, however not quite working yet.

sphinx can't import numpy.typing.NDArray, so I might have to go and remove all the NDArray types...