Skip to content

Latest commit

 

History

History
31 lines (17 loc) · 873 Bytes

README.md

File metadata and controls

31 lines (17 loc) · 873 Bytes

Pegasus Documentation

Documentation for SaaS Pegasus: the Django SaaS Boilerplate.

The latest docs can be found at docs.saaspegasus.com.

This project uses Sphinx.

Installation

Install using your favorite version from Sphinx's options.

The maintainer uses the pip version via pip install -r requirements.txt

Building Docs

To build docs run make html.

Viewing docs locally

You can use sphinx-autobuild to serve your docs locally and watch for changes:

sphinx-autobuild . _build/html/ --port 8001

The docs should now be visible at http://localhost:8000.

Deployment

Deployment is handled by Netlify. The latest main branch is automatically deployed.