Skip to content

czue/pegasus-docs

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
css
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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 python to serve your docs locally after building them:

cd _build/html
python -m http.server 8080

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

The following one-liner may be useful to clean, build, and serve the docs. Run this in the _build/html folder.

cd ../../ && rm -r _build && make html && cd _build/html/ && python -m http.server 8080

Deployment

Deployment is handled by Netlify. The latest master is automatically deployed.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published