c3c5277e05
No HTTP3/QUIC support yet. Note, allowing both here means we don't actually profit from HTTP2 multiplexing due to Finch(? or maybe a dependency of Finch?) limitations. But it means we can now interact with HTTP2-only instances (if such exist) and still may get minor gains from header compression etc Adventurous admins can change the config to allow only HTTP2, thus profiting from multiplexing (but breaking federation with HTTP1-only instances which are in fact observed to exist). |
||
|---|---|---|
| .. | ||
| docs | ||
| theme/partials | ||
| Makefile | ||
| mkdocs.yml | ||
| Pipfile | ||
| Pipfile.lock | ||
| README.md | ||
| requirements.txt | ||
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
# Accessible 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