pleroma/docs
ilja 6c396fcab4 Remove "default" image description
When no image description is filled in, Pleroma allowed fallbacks.
Those were (based on a setting) either the filename, or a fixed description.
Neither are good options for image descriptions imo, so here we remove this.

Note that there's two tests removed who supposedly tested something else.
But examining closer, they didn't seem to test what they claimed to test,
so I removed them rather than try to "fix" them.
2023-03-12 08:42:33 +01:00
..
docs Remove "default" image description 2023-03-12 08:42:33 +01:00
theme/partials Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00: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