Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 757 Bytes

README.md

File metadata and controls

27 lines (18 loc) · 757 Bytes

docat backend

The backend hosts the documentation and an api to push documentation and tag versions of the documentation.

development enviroment

You will need to install poetry pip install poetry==1.7.1.

Install the dependencies and run the application:

# install dependencies
poetry install
# run the app
[DOCAT_SERVE_FILES=1] [FLASK_DEBUG=1] [PORT=8888] poetry run python -m docat

Config Options

  • DOCAT_SERVE_FILES: Serve static documentation instead of a nginx (for testing)
  • DOCAT_STORAGE_PATH: Upload directory for static files (needs to match nginx config)
  • FLASK_DEBUG: Start flask in debug mode

Usage

See getting-started.md