git.squeep.com Git - akkoma/blob - docs/README.md

   1 ## Building the docs
   2
   3 You don't need to build and test the docs as long as you make sure the syntax is correct. But in case you do want to build the docs, feel free to do so.
   4
   5 ```sh
   6 # Make sure you're in the same directory as this README
   7 # From the root of the Akkoma repo, you'll need to do
   8 cd docs
   9
  10 # Optionally use a virtual environment
  11 python3 -m venv venv
  12 source venv/bin/activate
  13
  14 # Install dependencies
  15 pip install -r requirements.txt
  16
  17 # Run an http server who rebuilds when files change
  18 # Accessable on http://127.0.0.1:8000
  19 mkdocs serve
  20
  21 # Build the docs
  22 # The static html pages will have been created in the folder "site"
  23 # You can serve them from a server by pointing your server software (nginx, apache...) to this location
  24 mkdocs build
  25
  26 # To get out of the virtual environment, you do
  27 deactivate
  28 ```