Documentation

You can always find the latest docuemntation at the OSOP web site. http://www.osop.com.pa/sixaola-sphinx-doc/_build/html/index.html

Installing the documentation on your local computer

This part is about how to install the documentation on your local computer

Under Linux:

  1. Install git. In Ubuntu this is done as:

    $ sudo apt-get install git
    $ sudo apt-get install sphinx-doc sphinx-common sphinxbase-utils
    
  2. Change directory to where you want the documentation to live on your computer.

  3. Execute this git command:

    $ git clone https://gitlab.com/osop/sixaola-sphinx-doc.git
    
  4. Open your browser and navigate to: file:///{here is the path where you have clone the manual}/sixaola-sphinx-doc/_build/html/index.html

Under Windows:

  1. Install git (you may download it on https://git-scm.com/downloads)

  2. Install Sphinx (you may download it on http://sphinx-doc.org/install.html)

  3. Start Git and clone the sphinx Sixaola manual use the following command:

    $ git clone https://gitlab.com/osop/sixaola-sphinx-doc.git
    
  4. Open your browser and navigate to:

    file:///{here is the path where you have clone the manual}/sixaola-sphinx-doc/_build/html/index.html
    

Updating the documentation on your local computer

If you installed the software with git:

$ cd {here is the path where you have cloned the manual}/sixaola-sphinx-doc
$ git pull

Now refresh your browser.

Otherwise, email us at support@osop.com.pa and we will send you the latest version.