-
Notifications
You must be signed in to change notification settings - Fork 3
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
Initial docs #3
Comments
Use Sphinx for the "proper" docs – with support for code highlighting, cross-references(!), and other stuff you'll miss in the wiki. Then open the wiki for user contributions – for many people, that is a lower entry barrier, and you get the best of both worlds. Refactor wiki pages into the docs where appropriate. |
Yeah, that's close to what we already have @jhermann, just need to seperate out what we dumped here from other internal/product specific pieces. This and #1 is going to get my full focus very shortly as I polish up stuff on the development branch and detangle the last few pieces that are product specfic here. |
Hi there! Any news on the documentation? |
We have a set of internal docs which need to be reworked and the
pytestlab
specific stuff needs to come here.I was debating between using the new github wiki stuff vs. sphinx + readthedocs.
@vodik any opinion on that?
The text was updated successfully, but these errors were encountered: