https://github.com/czue/pegasus-docs

https://github.com/czue/pegasus-docs

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/czue/pegasus-docs
• Owner: czue
• Created: 2020-07-20T07:17:12.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T08:19:05.000Z (9 months ago)
• Last Synced: 2024-04-16T07:18:33.252Z (9 months ago)
• Language: Python
• Size: 2.31 MB
• Stars: 15
• Watchers: 4
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Pegasus Documentation

Documentation for [SaaS Pegasus: the Django SaaS Boilerplate](https://www.saaspegasus.com/).

The latest docs can be found at [docs.saaspegasus.com](https://docs.saaspegasus.com/).

This project uses [Sphinx](https://www.sphinx-doc.org/).

## Installation

Install using your favorite version [from Sphinx's options](https://www.sphinx-doc.org/en/master/usage/installation.html).

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](http://localhost:8000).

## Deployment

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