mirror of
				https://github.com/Akkudoktor-EOS/EOS.git
				synced 2025-10-30 14:26:21 +00:00 
			
		
		
		
	* Add package API documentation generation Add generation of the API documentation for akkudoktoreos and akkudoktoreosserver packages. The API documentation is generated by the Sphinx autosummary extension. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Enable Google style source commenting and documentation generation. Enable automatic documentation generation from Google style docstrings in the source. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Check Google style source commenting. Check Google style commenting by the appropriate ruff rules. Commenting is _NOT_ enforced. Missing docstrings are ignored. Minor commenting quirks of the code base are adapted. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Improve Markdown handling and switch to Markdown documentation. Switch to Markdown for the documentation files to improve the user and developer experience (see issue #181). Keep files with special directives for automatic API documentation in RST format. The directives expect RST. Also add dummy handling for openai/ swagger server documentation. The openai interface definition is for now taken from the fastapi PR as EOS will switch to fastAPI. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> --------- Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> Co-authored-by: Normann <github@koldrack.com>
		
			
				
	
	
		
			67 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
			
		
		
	
	
			67 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
| {{ fullname | escape | underline}}
 | |
| 
 | |
| .. automodule:: {{ fullname }}
 | |
| 
 | |
|    {% block attributes %}
 | |
|    {% if attributes %}
 | |
|    .. rubric:: Module Attributes
 | |
| 
 | |
|    .. autosummary::
 | |
|       :toctree:
 | |
|    {% for item in attributes %}
 | |
|       {{ item }}
 | |
|    {%- endfor %}
 | |
|    {% endif %}
 | |
|    {% endblock %}
 | |
| 
 | |
|    {% block functions %}
 | |
|    {% if functions %}
 | |
|    .. rubric:: {{ _('Functions') }}
 | |
| 
 | |
|    .. autosummary::
 | |
|       :toctree:
 | |
|    {% for item in functions %}
 | |
|       {{ item }}
 | |
|    {%- endfor %}
 | |
|    {% endif %}
 | |
|    {% endblock %}
 | |
| 
 | |
|    {% block classes %}
 | |
|    {% if classes %}
 | |
|    .. rubric:: {{ _('Classes') }}
 | |
| 
 | |
|    .. autosummary::
 | |
|       :toctree:
 | |
|       :template: autosummary/class.rst
 | |
|    {% for item in classes %}
 | |
|       {{ item }}
 | |
|    {%- endfor %}
 | |
|    {% endif %}
 | |
|    {% endblock %}
 | |
| 
 | |
|    {% block exceptions %}
 | |
|    {% if exceptions %}
 | |
|    .. rubric:: {{ _('Exceptions') }}
 | |
| 
 | |
|    .. autosummary::
 | |
|       :toctree:
 | |
|    {% for item in exceptions %}
 | |
|       {{ item }}
 | |
|    {%- endfor %}
 | |
|    {% endif %}
 | |
|    {% endblock %}
 | |
| 
 | |
| {% block modules %}
 | |
| {% if modules %}
 | |
| .. rubric:: Modules
 | |
| 
 | |
| .. autosummary::
 | |
|    :toctree:
 | |
|    :template: autosummary/module.rst
 | |
|    :recursive:
 | |
| {% for item in modules %}
 | |
|    {{ item }}
 | |
| {%- endfor %}
 | |
| {% endif %}
 | |
| {% endblock %}
 |