-
Notifications
You must be signed in to change notification settings - Fork 24
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: initial #198
docs: initial #198
Conversation
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
Expected release notes (by @arys-splunk) features: fixes: others (will not be included in Semantic-Release notes):
|
I have read the CLA Document and I hereby sign the CLA |
recheck |
🎉 This PR is included in version 5.0.0-develop.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
🎉 This PR is included in version 5.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
I've added Sphinx, sphinx-rtd-theme as a requirements to the poetry.
This is an initial version of the docs. I used a README.md as a baseline and reorganised it in Sphinx docs (not adding a lot of new information). It is not yet integrated with readthedocs, but that can be one of next steps when we will be happy with the docs themselves.
What you need to do to see the docs:
poetry install
cd docs
make html
open _build/html/index.html
You should see the same page from the screenshot.
