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

Omnivector Slurm Distribution Documentation

Explore the docs »

Report Bug · Request Feature

Table of Contents

• Table of Contents
• Prerequisites
• Building the documentation
• License
• Contact
• Acknowledgements

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 - [email protected]

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

Acknowledgements

• Choose an Open Source License
• GitHub Pages