Vicharak Documentation

reStructuredText/Markdown preferred documentation, generated using Sphinx.

Installation

Windows Installation Guide

Linux Installation Guide

Editing Guide

Read the Editing Guide

Extensions

MYST markdown parser
Breathe for autodoc
sphinx-design for MYST admonitions
sphinx-favicon for custom favicon
sphinx-togglebutton for dropdown content sphinx awesome theme

⚠️ Important extension
sphinxcontrib spelling checker

Read how to use spelling checker

Resources

sphinx documentation
rst primer
rst cheatsheet