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 You'll need to install mkdocs for which you can check the [mkdocs installation guide](https://www.mkdocs.org/#installation). Generally it's best to install it using `pip`. You'll also need to install the correct dependencies.
   6
   7 ### Example using a Debian based distro
   8
   9 #### 1. Install pipenv and dependencies
  10
  11 ```shell
  12 pip install pipenv
  13 pipenv sync
  14 ```
  15
  16 #### 2. (Optional) Activate the virtual environment
  17
  18 Since dependencies are installed in a virtual environment, you can't use them directly. To use them you should either prefix the command with `pipenv run`, or activate the virtual environment for current shell by executing `pipenv shell` once.
  19
  20 #### 3. Build the docs using the script
  21
  22 ```shell
  23 [pipenv run] make all
  24 ```
  25
  26 #### 4. Serve the files
  27
  28 A folder `site` containing the static html pages will have been created. You can serve them from a server by pointing your server software (nginx, apache...) to this location. During development, you can run locally with
  29
  30 ```shell
  31 [pipenv run] mkdocs serve
  32 ```
  33
  34 This handles setting up an http server and rebuilding when files change. You can then access the docs on <http://127.0.0.1:8000>