Skip to content
Documentation for the Veres One Project
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
veresone_theme
.editorconfig
.gitignore
README.md
mkdocs.yml
requirements.txt

README.md

Veres One Documentation

Documentation for the Veres One Project.

Tool Installation

This site uses MkDocs and Material for MkDocs.

It is highly recommended to setup a Python virtual environment to install the doc tools. You can install globally also.

In your development environment, install the tools:

$ pip install -r requirements.txt

Development

Site source files are in the docs directory.

Verify your changes with the MkDocs development server:

$ mkdocs serve

Deploy

To build and deploy to the gh-pages branch use the following:

$ mkdocs gh-deploy

Changes should shortly appear on the Veres One site.

You can’t perform that action at this time.