Skip to content

ybwong/Docs

 
 

Repository files navigation

Technical Contributor Guide

This repository contains documentation for Aviatrix written using the reStructuredText format.

Publishing

HTML documentation is generated using Sphinx. Shortly after a commit is pushed to this repository, the latest source is turned into HTML files and published to docs.aviatrix.com.

How To Generate

If you'd like to generate the documentation yourself, follow the steps outlined below.

Install Sphinx

  1. Install the latest version of Sphinx

  2. Install sphinx-rtd-theme

    pip install sphinx-rtd-theme

  3. Install sphinxcontrib-disqus

    pip install sphinxcontrib-disqus

Build output with Sphinx

To generate the output, use the sphinx-build command. It has a lot of options; but, the simple case of generating HTML output looks like:

sphinx-build -b html . ./output

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 53.2%
  • Python 29.8%
  • CSS 9.8%
  • Batchfile 4.0%
  • Makefile 3.2%