search

pyOpenSci / pyosPackage

An example package that compliments our package guide & tutorials.
https://pyospackage.readthedocs.io/en/latest/
MIT License
0 stars 1 forks source link

Add: documentation to package #26

Closed lwasser closed 1 week ago

lwasser commented 1 week ago

closes #18

This is a basic representation of documentation. I am going to add API docs next and then merge it. it needs a lot of work but the point is more about the setup - eventually we will flesh out the docs to explain each part of this package.

lwasser commented 1 week ago

Landed on using autoapi for docstring docs. it had the cleanest out of the box output.