Skip to content

usharesoft/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 

Repository files navigation

UForge Product Documentation

This directory contains the source for UForge online documentation. This contains only the global table of contents for all the UForge product documentation. This uses Sphinx to build static html files from these source files.

Building locally

Install Sphinx

$ pip install sphinx

Install read the docs theme:

$ pip install sphinx_rtd_theme

Build the docs and open them in your browser:

$ cd toc
$ make html
$ open build/html/index.html

Contributions Welcome!

If you find a typo or you feel like you can improve the content of the documentation, we welcome contributions and comments. Feel free to open issues or pull requests like any normal GitHub project.