mirror of
https://akkoma.dev/AkkomaGang/akkoma.git
synced 2024-11-10 19:29:11 +00:00
e74e1efe1c
Docs used to be a separate repo who cloned pleroma and pelroma-fe. Now the docs are just the BE docs and completely part of the Akkoma repo. I moved back to using venv because that's what I used and cleaner imo since it keeps everything nice in the repo. (Iirc virtualenv stored things in the Home folder or smthng)
28 lines
812 B
Markdown
28 lines
812 B
Markdown
## Building the docs
|
|
|
|
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.
|
|
|
|
```sh
|
|
# Make sure you're in the same directory as this README
|
|
# From the root of the Akkoma repo, you'll need to do
|
|
cd docs
|
|
|
|
# Optionally use a virtual environment
|
|
python3 -m venv venv
|
|
source venv/bin/activate
|
|
|
|
# Install dependencies
|
|
pip install -r requirements.txt
|
|
|
|
# Run an http server who rebuilds when files change
|
|
# Accessable on http://127.0.0.1:8000
|
|
mkdocs serve
|
|
|
|
# Build the docs
|
|
# The static html pages will have been created in the folder "site"
|
|
# You can serve them from a server by pointing your server software (nginx, apache...) to this location
|
|
mkdocs build
|
|
|
|
# To get out of the virtual environment, you do
|
|
deacivate
|
|
```
|