PyNomaly icon indicating copy to clipboard operation
PyNomaly copied to clipboard

Library documentation

Open vc1492a opened this issue 6 years ago • 2 comments

As the current capabilities of PyNomaly are solidified and new capabilities added, it would be beneficial to have dedicated documentation that is hosted and available to users outside of the readme.

vc1492a avatar Dec 02 '19 16:12 vc1492a

I did some research this morning over coffee ☕ on this topic.

One way forward would be to use sphinx together with these Github Actions:

  1. https://github.com/marketplace/actions/sphinx-builder
  2. https://github.com/marketplace/actions/sphinx-publisher

You can see a results demo of those Github actions here.

vc1492a avatar Aug 24 '24 14:08 vc1492a

Also documenting this resource.

vc1492a avatar Aug 24 '24 14:08 vc1492a