Skip to content

TechWorksHub/best-practice-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Techworks Best Practices in AI Guide

This repository contains the Techworks Best Practices in AI guide.

You can find the published version of the guide here

Installing requirements

This guidance is maintained in Sphinx. It currently uses a version of the furo theme. Sphinx has strong integration with Python, which makes installation fairly easy.

Requirements:

  • Python 3.9+
  • Sphinx
  • Furo theme

To install:

Then: pip install -U sphinx

And: pip install -U furo

Building

To build the guide in html format run the following in a terminal in the root directory of the repository:

sphinx-build -b html source build

To build the guide in pdf format:

sphinx-build -b pdf source build