openwisp2-docs icon indicating copy to clipboard operation
openwisp2-docs copied to clipboard

OpenWISP 2 Docs

======================== OpenWISP 2 Documentation

This repository aims to help out new users and contributors to get start using and getting involved in OpenWISP <http://openwisp.org>_.

This repo at this stage is pretty much a work in progress, so contributions, feedback and suggestions are very welcome.

How to build the docs

Requirements: Python >= 3.9.

  1. Fork this repository

  2. Clone this repository using the following command::

  git clone https://github.com//openwisp2-docs.git

  1. Install sphinx on your local machine using::

    pip install -r requirements.txt

  2. Build HTML::

    make html

  3. Open the generated HTML files in your browser.

Need help?

  • If any help regarding installing and using sphinx and reStructured Text is required then please visit this link <http://www.sphinx-doc.org/en/stable/tutorial.html>_.

  • Feel free to post any doubt or comment through our support channels <http://openwisp.org/support.html>_.