Skip to content
A documentation generator for open hardware projects.
Python HTML Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images
material
templates
.gitignore
CHANGELOG.md
LICENSE
Makefile
README.md
app.py
json-validation.py
project.json
requirements.txt
wsgi.py

README.md

myworkshop

A documentation generator for open hardware projects.

Features

  • Generate beautiful documentation for open hardware projects from source files stored on GitHub!

Getting started

Requirements

  • python 3.6 or higher (package python3);

Install

Install all the required tools in a virtualenv:

$ make install

Serve

To run the application locally:

$ make serve

Additional tools

To test if project.json is a valid JSON file:

$ make test-json

Tech/framework used

Versioning

We use SemVer for versioning. See the CHANGELOG.md file for details.

Contributing

If you'd like to contribute, please raise an issue or fork the repository and use a feature branch. Pull requests are warmly welcome.

Licensing

The code in this project is licensed under MIT license. See the LICENSE file for details.

Contributors

You can’t perform that action at this time.