akkoma/docs
FloatingGhost 6e293b9280
Some checks are pending
ci/woodpecker/push/build-amd64 Pipeline is pending
ci/woodpecker/push/build-arm64 Pipeline is pending
ci/woodpecker/push/docs Pipeline is pending
ci/woodpecker/push/test Pipeline is pending
ci/woodpecker/pr/test Pipeline was successful
ci/woodpecker/pr/build-amd64 Pipeline was successful
ci/woodpecker/pr/build-arm64 Pipeline was successful
ci/woodpecker/pr/docs Pipeline was successful
Bump versions in use in the docs
2023-08-04 14:19:18 +01:00
..
docs Bump versions in use in the docs 2023-08-04 14:19:18 +01:00
theme/partials more references being updated 2023-05-26 22:54:12 -04:00
Makefile add manual deploy for docs 2022-11-10 10:55:57 +00:00
mkdocs.yml Add dark and light theme mode to docs, detection, and button 2022-12-09 22:51:43 -05:00
Pipfile Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
Pipfile.lock varnish config/docs (#342) 2022-12-05 13:39:27 +00:00
README.md typo + remove unneeded file 2023-02-02 14:37:45 +01:00
requirements.txt fix requirements 2022-11-11 16:07:07 +00:00

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.

# 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
deactivate