Skip to content
/ docs Public

[WIP] In-depth documentation of the ohua project

Notifications You must be signed in to change notification settings

ohua-dev/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ohua Documentation Documentation Status

Read the rendered version of this documentation on readthedocs

Installing

Engine and building

Ohua's documentation uses the Sphinx to generate html documentation from reStructuredText.

The Sphinx engine can be installed easily with pip install Sphinx.

Sphinx supports several different output types and there is a makefile provided for running the build. For instance if we want to build the html version run make html. The generated html will be in build/html.

Update to the online hosted documentation simply push to the master branch of this repository.

Theme

The ohua docs use the Sphinx theme provided by ReadTheDocs. Instructions on how to install the theme can be found here.

About

[WIP] In-depth documentation of the ohua project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published