Coder Social home page Coder Social logo

Write user docs for v1. about openhtf HOT 6 OPEN

google avatar google commented on May 19, 2024 1
Write user docs for v1.

from openhtf.

Comments (6)

jettisonjoe avatar jettisonjoe commented on May 19, 2024

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

from openhtf.

DanLipsitt avatar DanLipsitt commented on May 19, 2024

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.

fahhem avatar fahhem commented on May 19, 2024

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

from openhtf.

fahhem avatar fahhem commented on May 19, 2024

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

from openhtf.

DanLipsitt avatar DanLipsitt commented on May 19, 2024

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.

wizofe avatar wizofe commented on May 19, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.