Skip to content
This repository was archived by the owner on Dec 20, 2022. It is now read-only.

Latest commit

 

History

History
31 lines (17 loc) · 927 Bytes

File metadata and controls

31 lines (17 loc) · 927 Bytes

Ceasefire contracting

CodeFactor

Documentation

The documentation of this project may be built with Sphinx.

Also there are some diagrams, describing workflow and code structure of the project. You can find them in docs/ceasefire_diagrams.xml and open them with draw.io

How to build it

Commands to build the docs:

python bootstrap.py -c docs.cfg --buildout-version 2.2.5

./bin/buildout -c docs.cfg

./bin/docs

To set language or manage some other stuff, edit docs/source/conf.py

To update files with requests data for tutorial:

./bin/buildout to restore nosetests in the bin directory

./bin/nosetests -sv docs/update_tutorial_requests.py

There is deeper doc about building docs, but it can be obsolete somewhere: Docs instruction