-
Notifications
You must be signed in to change notification settings - Fork 4
Set up documentation for automated CI #86
Copy link
Copy link
Open
Labels
deliverableAdd this label if this is for a deliverableAdd this label if this is for a deliverabledocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is neededpython:uvPull requests that update python:uv codePull requests that update python:uv code
Metadata
Metadata
Assignees
Labels
deliverableAdd this label if this is for a deliverableAdd this label if this is for a deliverabledocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is neededpython:uvPull requests that update python:uv codePull requests that update python:uv code
Set up documentation for DetectMateService with configurations in separate files outside of the md file.
MkDocs allows to include external files when generating documentation.
This could be done like this:
--8<-- "configs/example.yaml"or even with multiple files:
You can also create sections of the configs, if you only want to reference specific parts:
and then:
--8<-- "configs/example.yaml:service"This would allow an easy way to test important parts of the documentation in CI and fix outdated documentation immediately, the same way we tried to do it with the AMiner.