Add Sphinx Documentation#72
Merged
OleSeifert merged 5 commits intodevelopfrom Jun 15, 2025
Merged
Conversation
* Add proper documentation for the project * This also contains automatically generated documentation
* Add github-pages extension to enable a smooth hosting * Clean command to makefile to enable a correct, easier setup
* There was the wrong directory
* Everytime there is a change on main, the documentation is updated
* Used the wrong path, images were not showing on published site
samadrita-saha
approved these changes
Jun 15, 2025
Collaborator
samadrita-saha
left a comment
There was a problem hiding this comment.
LGTM. Nice work! :)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces comprehensive documentation for the backend system, including a detailed system architecture overview, API endpoints, and associated models. Additionally, it provides supporting files for building and generating documentation using Sphinx. The most important changes are grouped into themes below:
Documentation for System Architecture and Backend Components:
docs/source/architecture.rstto explain the backend architecture, interaction with the Celonis platform, and key components like conformance checking techniques, PQL queries, and API structure.Auto-Generated API Documentation:
docs/source/autoapi/backend/api/celonis/index.rstto document thebackend.api.celonismodule, including theCelonisSettingsclass andget_celonis_connectionfunction.docs/source/autoapi/backend/api/log/index.rstto document thebackend.api.logmodule, including routes for uploading logs and committing them to the Celonis platform.docs/source/autoapi/backend/api/jobs/index.rstto describe thebackend.api.jobsmodule, including job-related routes and helper functions.Supporting Files for Sphinx Documentation:
docs/Makefileto define commands for generating documentation using Sphinx, including targets for building and generating.rstAPI files.docs/make.batto provide equivalent functionality for Windows environments.These changes enhance the project's documentation, making it easier for developers to understand the backend architecture and interact with its APIs.
Important files
The only important files are the
.rstfiles in thedocs/sourcedirectory, as these are not automatically generated.