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

Initial docs #3

Open
goodboy opened this issue Feb 28, 2017 · 3 comments
Open

Initial docs #3

goodboy opened this issue Feb 28, 2017 · 3 comments

Comments

@goodboy
Copy link
Contributor

goodboy commented Feb 28, 2017

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?

@jhermann
Copy link

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.

@vodik
Copy link
Contributor

vodik commented Jun 12, 2017

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.

@tacerus
Copy link

tacerus commented May 18, 2023

Hi there! Any news on the documentation?

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

No branches or pull requests

4 participants