klipper-dgus/docs/_klipper3d
Frank Tackitt 638cd4d781 docs: add exclude_object documentation
Also include sample macros to add M486 compatibility.

Signed-off-by: Franklyn Tackitt <git@frank.af>
Co-authored-by: Troy Jacobson <troy.d.jacobson@gmail.com>
2022-06-03 14:12:04 -04:00
..
css _klipper3d: Add comments to files in this directory 2021-07-27 13:49:06 -04:00
README _klipper3d: New language translation deployment 2022-04-06 19:04:48 -04:00
build-translations.sh _klipper3d: Specify mkdocs language config options 2022-04-06 19:04:48 -04:00
mkdocs-requirements.txt _klipper3d: Remove translation stubs 2022-04-06 19:04:48 -04:00
mkdocs.yml docs: add exclude_object documentation 2022-06-03 14:12:04 -04:00
mkdocs_hooks.py mkdocs_hooks: Improve check for not in a list 2021-08-02 16:14:54 -04:00

README

This directory defines the https://www.klipper3d.org/ website. The
site is hosted using "github pages". The
.github/workflows/klipper3d-deploy.yaml tool uses mkdocs (
https://www.mkdocs.org/ ) to automatically convert the markdown files
in the docs/ directory to html. In addition to the files in this
directory, the docs/CNAME file also controls the website generation.

To test deploy the main English site locally one can use commands
similar to the following:

virtualenv ~/mkdocs-env && ~/python-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt
cd ~/klipper && ~/mkdocs-env/bin/mkdocs serve --config-file ~/klipper/docs/_klipper3d/mkdocs.yml -a 0.0.0.0:8000

To test deploy the multi-language site locally one can use commands
similar to the following:

virtualenv ~/mkdocs-env && ~/python-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt
source ~/mkdocs-env/bin/activate
cd ~/klipper && ./docs/_klipper3d/build-translations.sh
cd ~/klipper/site/ && python3 -m http.server 8000