Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: minor fixup - inserting API details #29

Merged

Conversation

Lucas-C
Copy link
Contributor

@Lucas-C Lucas-C commented Jan 17, 2025

Fix this:
image

Into this:
image

Note: if in the end the Doxygen + breathe setup does not bring up much added value,
in regards to the concerns expressed in #25 (comment),
feel free to get rid of it.
Maybe we can give it a few weeks / months to evaluate the benefit.
AMHA the Markdown-based Sphinx documentation is the most valuable part of the generated documentation.

@felixguendling felixguendling merged commit ea6bcff into motis-project:master Jan 17, 2025
13 checks passed
@felixguendling
Copy link
Member

Thank you! :)

Until now we didn't have the developer capacities to document everything and knowledge was shared within the office at Technical University of Darmstadt. Most of the code was written at times when everyone working on MOTIS worked in the same room. This changed now, so we have to adapt our approach on sharing knowledge. I think this is a good starting point. I also added a style guide to the main repo.

@Lucas-C Lucas-C deleted the fix-docs-api-details branch January 17, 2025 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants