Development Guideline

Guidelines for Software Development Projects

Setup

$ python -m venv .venv
$ .venv/bin/pip install -r requirements.txt

Build

Sphinx can generate different formats. To see a list of options:

$ make

Then run:

$ make [format]

History

This document is a mix of different documents that I created at companies where I used to work.

This document is incomplete, with parts in Brazilian Portuguese, and lots of 'TODOs'.