madalintat / build_the_bot

Bot built during the Robot_Dreams workshop.

Introduction to DevOps documentation

Documentation is made using Sphinx, to build it:

1. Create and init a virtual environment

   python3.11 -m venv venv
   source venv/bin/activate

2. Install Python dependencies

   pip install -r requirements.txt

3. Build documentation

   make html

4. To read the documentation - open explorer.exe

   explorer.exe .

To have documentation available on GitHub pages you need to copy the files from build/html to docs (limitation from gh-pages) then will pick the index.html

rm -rf docs/* && cp -R build/html/* docs/ && touch docs/.nojekyll