jordyparker/openwisp2-docs

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.

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

1. Fork this repository

2. Clone this repository using the following command:

   git clone https://github.com/<your-username>/openwisp2-docs.git
   

3. Install sphinx on your local machine using:

   pip install -r requirements.txt
   

4. Build HTML:

   make html
   

5. 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.
• Feel free to post any doubt or comment through our support channels.