/osd-documentation

Documentation for the Omnivector Slurm Distribution

Primary LanguagePythonMIT LicenseMIT

Contributors • Forks • Stargazers • Issues • MIT License • Website


Logo

Omnivector Slurm Distribution Documentation

Explore the docs »

Report Bug · Request Feature

Table of Contents

Prerequisites

Before you begin, ensure you have met the following requirements:

  • A modern Python installation
  • sphinx

Building the documentation

  1. Clone the repository: 
    $ git clone https://github.com/omnivector-solutions/osd-documentation.git
  2. Install the dependencies: 
    $ cd ./osd-documentation
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
  3. Build the HTML docs: 
    $ make html

The result is in the build/html/ directory. Use your favorite browser to open the index.html.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Omnivector Solutions - www.omnivector.solutions - info@omnivector.solutions

Project Link: https://github.com/omnivector-solutions/osd-documentation

Acknowledgements