https://github.com/octoprint/docs.octoprint.org

Source & deployment files of docs.octoprint.org
https://github.com/octoprint/docs.octoprint.org

Last synced: 3 months ago
JSON representation

Source & deployment files of docs.octoprint.org

• Host: GitHub
• URL: https://github.com/octoprint/docs.octoprint.org
• Owner: OctoPrint
• Created: 2020-06-11T10:01:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-06-04T16:27:40.000Z (7 months ago)
• Last Synced: 2025-06-04T22:10:58.262Z (7 months ago)
• Language: Python
• Homepage: https://docs.octoprint.org
• Size: 43.8 MB
• Stars: 1
• Watchers: 3
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 📚 docs.octoprint.org

You are looking at the files used to build [OctoPrint's](https://octoprint.org) documentation

as published on [docs.octoprint.org](https://docs.octoprint.org).

It is implemented through the github workflow under `.github/workflows/docs.yaml` and relies

on a custom sphinx wrapper located in `util/versionselector` as well as a little helper

located in `util/versions_from_matrix.py`.

**Builds are triggered** via a webhook from [OctoPrint/OctoPrint](https://github.com/OctoPrint/OctoPrint)

on pushes and new tagged releases, and on push to `master` on this repository.

Webhook triggers cause only a single doc version to be rebuilt (if any). Pushes however trigger 

a full rebuild of all registered doc versions.

**To register a new version to be built and served**, edit the build matrix configured

in `.github/workflows/docs.yaml`. Do not use anything but `include` statements for that or

the version extraction during build will no longer work.