Skip to content

A sphinx based documentation site providing step-by-step guides, architecture & design, and other information regarding the Koinos blockchain and framework.

License

Notifications You must be signed in to change notification settings

jredbeard/koinos-docs

 
 

Repository files navigation

Koinos Documentation

This repo contains the Koinos documentation site. The site is built using the Sphinx documentation generator.

Installation

To run the generator locally, clone the repo and follow the instructions below using Python 3.

  1. Install the dependenices listed in requirements.txt
pip install -r requirements.txt
  1. Run the sphinx-build command to build the site serve it on localhost:8000 (autobuild will live-reload when changes are made)
sphinx-autobuild docs docs/_build/html

About

A sphinx based documentation site providing step-by-step guides, architecture & design, and other information regarding the Koinos blockchain and framework.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%