Kenwood
/
InstrumentVisor
1
1
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
InstrumentVisor/Docs
History
Kenwood 71329d5484 Import from https://github.com/KenwoodFox/Project-Template 2023-12-26 16:55:02 -05:00
..
introduction Import from https://github.com/KenwoodFox/Project-Template 2023-12-26 16:55:02 -05:00
resources Import from https://github.com/KenwoodFox/Project-Template 2023-12-26 16:55:02 -05:00
.gitignore Import from https://github.com/KenwoodFox/Project-Template 2023-12-26 16:55:02 -05:00
Makefile Import from https://github.com/KenwoodFox/Project-Template 2023-12-26 16:55:02 -05:00
README.md Import from https://github.com/KenwoodFox/Project-Template 2023-12-26 16:55:02 -05:00
conf.py Import from https://github.com/KenwoodFox/Project-Template 2023-12-26 16:55:02 -05:00
index.rst Import from https://github.com/KenwoodFox/Project-Template 2023-12-26 16:55:02 -05:00
requirements.txt Import from https://github.com/KenwoodFox/Project-Template 2023-12-26 16:55:02 -05:00

README.md

Building the Docs

To get started, you'll need a few things, you should have pipenv (or your favorite python container tool). And some familiarly with RST.

To begin, install the requirements into your python environment

pipenv install -r requirements.txt
pipenv shell

To make things easier, this project uses a build tool called make

To use it just run

make

Thats it! Make some edits, and then run make html