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

Write user docs for v1. #44

Open
jettisonjoe opened this issue Oct 21, 2015 · 6 comments
Open

Write user docs for v1. #44

jettisonjoe opened this issue Oct 21, 2015 · 6 comments

Comments

@jettisonjoe
Copy link
Contributor

We have this nice wiki feature. We should actually consider using it.

@jettisonjoe
Copy link
Contributor Author

We should look into https://readthedocs.org/ for this.

@DanLipsitt
Copy link
Contributor

We'd be happy if you start a docs/ folder :)
@fahhem in #613

If I create a config compatible with readthedocs, will a project member create an account there and link it to this repo so the docs get built and hosted?

@fahhem
Copy link
Collaborator

fahhem commented Aug 13, 2017

Yup, 100% I will! I already have 2 of my personal repos on there

@fahhem
Copy link
Collaborator

fahhem commented Aug 13, 2017

Oh, looks like @maddychan already did that. Any chance she can add Joe and myself as owners? https://readthedocs.org/projects/openhtf/

@DanLipsitt
Copy link
Contributor

I've got autogenerated doc builds working in #641. I'm using PBR and right now it seems to be interfering with protobuf builds. I'm pretty sure the solution is to move some of the config from setup.py to setup.cfg so that PBR can access it. Before I invest more in PBR, I want to see how you feel about using it. I think it has several benefits in addition to making Sphinx easier. The alternative to using it seems to be to add configuration to run sphinx-autogen automatically or to remember to run it manually whenever code changes.

@wizofe
Copy link

wizofe commented Feb 27, 2018

I am considering on using OpenHTF to test our Raspberry Pi3 based Linux "flavour"/distro and could be more than happy to offer some help with the documentation or anything around. Let me know.

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

No branches or pull requests

5 participants