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.

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

Docs Update #23

Merged
merged 9 commits into from
Mar 6, 2022
Merged

Docs Update #23

merged 9 commits into from
Mar 6, 2022

Conversation

zStupan
Copy link
Collaborator

@zStupan zStupan commented Mar 5, 2022

  • Added optional docs dependencies. They can now be installed with poetry install --extras docs.
  • Added API Reference
  • Added a section for the command line interface
  • Updated other docs

The docs now build without warnings. The CLI section is still incomplete. I have to think of something to write.
I did not include the AssociationRule class in the API Reference, since it's basically just an internal util class for the NiaARM class and it's probably never gonna be used by the end users.

@zStupan zStupan requested a review from firefly-cpp March 5, 2022 22:13
Copy link
Owner

@firefly-cpp firefly-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant!

@firefly-cpp firefly-cpp merged commit 7f27b1e into firefly-cpp:main Mar 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants