asvin facilitates Platform as a Service to distribute over the air firmware updates for IoT devices.
If you want the world to read asvin documentation in your own language, you are welcome to translate it. The documentation is already available in German and English. Therefore, you can contribute in the existing translations or add a new language if it doesn't exist.
asvin uses Read the Docs for software documentation. It facilitates automatic building, versioning, and hosting of the documentation. The Sphinx tool is used to build the documentation using the theme. The documentation is generated for each commit in the master branch. Therefore, it is advised to build locally for update, preview and design. The section describe the procedure. You could find the latest version of documentation online.
-
Download and install latest version of Python from here
-
Clone the repo
git clone https://github.com/Asvin-io/asivn-docs.git -
Install dependencies
cd documentation/docs pip3 install -r requirements.txt
Make your changes and run following commands to generate html documentation.
cd asvin-docs/docs/locale/en
make html
Open build/html/index.html file in a browser.
When all the changes are according to your needs then push changes or make pull request.
Please find further information about the architecture, getting started and tutorials in our online documentation.
Find out more about us
asvin is an Open Source project. We welcome your contribution in the project.
The information here is made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file.