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

Documentation #32

Closed
amirhessam88 opened this issue Sep 10, 2020 · 5 comments
Closed

Documentation #32

amirhessam88 opened this issue Sep 10, 2020 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@amirhessam88
Copy link
Member

Here we can brainstorm the option for writing the documentations and API details. I have seen mostly use readthedocs and Sphinx.
Any other options ?

@amirhessam88
Copy link
Member Author

I think we need to have slickml.github.io blog for all the documentations and walk-through. any thoughts ?

@amirhessam88
Copy link
Member Author

We can also use this https://pages.github.com/
idk which one is better, but sooner or later we need to start writing the documentations. Since, the package is getting bigger.

@Tsmith5151
Copy link
Contributor

Tsmith5151 commented Jul 14, 2021

Agree on using Sphinx to build the docs and tutorials. For readthedocs, a webhook is configured with the project repo and automatically runs a new build to re-generate the updated docs on each merged PR. Also, minimal steps to have the docs published.

@amirhessam88
Copy link
Member Author

Awesome. Please start the doc part. As we discussed we can do something similar to SHAP docs.

@amirhessam88 amirhessam88 self-assigned this May 29, 2022
@amirhessam88 amirhessam88 added the documentation Improvements or additions to documentation label May 29, 2022
@amirhessam88
Copy link
Member Author

Addresed in #77

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants