Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Library documentation #34

Open
vc1492a opened this issue Dec 2, 2019 · 2 comments
Open

Library documentation #34

vc1492a opened this issue Dec 2, 2019 · 2 comments
Assignees
@vc1492a
Labels
documentation This issue relates to documentation enhancement New feature of request
Milestone
Improve Versionin...

Comments

@vc1492a
Copy link
Owner

vc1492a commented Dec 2, 2019

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 vc1492a added the enhancement New feature of request label Dec 2, 2019
@vc1492a vc1492a added the documentation This issue relates to documentation label May 29, 2020
@vc1492a
Copy link
Owner Author

vc1492a commented Aug 24, 2024

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 vc1492a self-assigned this Aug 24, 2024
@vc1492a
Copy link
Owner Author

vc1492a commented Aug 24, 2024

Also documenting this resource.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vc1492a vc1492a

Labels
documentation This issue relates to documentation enhancement New feature of request
Projects
None yet
Milestone
Improve Versioning Process and Commun...
Development

No branches or pull requests
1 participant
@vc1492a