Comments (6)
We should look into https://readthedocs.org/ for this.
from openhtf.
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?
from openhtf.
Yup, 100% I will! I already have 2 of my personal repos on there
from openhtf.
Oh, looks like @maddychan already did that. Any chance she can add Joe and myself as owners? https://readthedocs.org/projects/openhtf/
from openhtf.
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.
from openhtf.
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.
from openhtf.
Related Issues (20)
- If plug configuration is dynamic (e.g. configs loaded from a file), how can the decorators be updated accordingly? HOT 2
- frontend_example with PyInstaller HOT 3
- Running a phase in backgroud HOT 7
- Request: Add ability to FAIL_AND_CONTINUE instead of STOP when a Phase reaches max_repeats
- How to build a test running multiple test groups concurrently, but showing I/O data of all test groups on the same webpage? HOT 1
- HIL testing? HOT 5
- multiple monitors for a single phase?
- KeyError in `PlugManager.provide_plugs` HOT 6
- monitors decorator does not fully copy the specification of the monitored phase
- Feature Request(?): Provide a mechanism for displaying images in the front-end HOT 1
- Progress bar/completion status stops if test is marked as FAIL. HOT 4
- How could I call a PhaseDescriptor explicitly? HOT 3
- runtime reporting/logging for each phase during test HOT 6
- Having trouble using the unit test decorator @test.patch_plugs to mock a device I'm testing. HOT 3
- where PyOpenSSL is used?
- Unused `six` import in monitor code
- Replacing `M2Crypto` dependency with `cryptography`
- Status LED on failure HOT 1
- Multiple tests or one test and multiple subtests?
- Best practice on how to organize product-dependent tests
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from openhtf.