.. include:: /../common/authors.txt

Get started

Please follow the steps below to install Sphinx and get the source code from our Git repository.

1. Install Python

Download and install Python 3.6.0 from here https://www.python.org/downloads/

Note

Make sure to select pip and Add Python to environment variables during the installation

2. Install Sphinx

  1. Open a command prompt

  2. Run

    pip install sphinx sphinx-autobuild sphinx_rtd_theme

3. Install Git for Windows

Download and install Git from here https://git-scm.com/download/win

4. Get the Git repository

  1. Create a folder in your file system where you would like to keep the documentation source code, for example

    C:\Git\OMF-docs

  2. In a command prompt, navigate to the folder you just created and execute the following command

    git clone https://github.com/preciofishbone/Omnia-Foundation-Docs.git

The source code is now cloned to the current folder