You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
akkoma/docs
floatingghost 56c37dc6b3
ci/woodpecker/push/woodpecker Pipeline is pending Details
Merge pull request 'DOCS: Add info on fe to setup of dev env' (#456) from ilja/akkoma:docs_add_fe_to_akkoma_dev into develop
6 days ago
..
docs Merge pull request 'DOCS: Add info on fe to setup of dev env' (#456) from ilja/akkoma:docs_add_fe_to_akkoma_dev into develop 6 days ago
theme/partials Documentation updates for stable release (#73) 7 months ago
Makefile add manual deploy for docs 3 months ago
Pipfile Documentation updates for stable release (#73) 7 months ago
Pipfile.lock varnish config/docs (#342) 2 months ago
README.md Documentation updates for stable release (#73) 7 months ago
mkdocs.yml Add dark and light theme mode to docs, detection, and button 2 months ago
requirements.txt fix requirements 3 months ago

README.md

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.

You'll need to install mkdocs for which you can check the mkdocs installation guide. Generally it's best to install it using pip. You'll also need to install the correct dependencies.

Example using a Debian based distro

1. Install pipenv and dependencies

pip install pipenv
pipenv sync

2. (Optional) Activate the virtual environment

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.

3. Build the docs using the script

[pipenv run] make all

4. Serve the files

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

[pipenv run] mkdocs serve

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