mirror of
				https://github.com/Akkudoktor-EOS/EOS.git
				synced 2025-11-03 16:26:20 +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>
		
			
				
	
	
		
			34 lines
		
	
	
		
			630 B
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
			
		
		
	
	
			34 lines
		
	
	
		
			630 B
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
{{ fullname | escape | underline}}
 | 
						|
 | 
						|
.. currentmodule:: {{ module }}
 | 
						|
 | 
						|
.. autoclass:: {{ objname }}
 | 
						|
   :members:
 | 
						|
   :undoc-members:
 | 
						|
   :show-inheritance:
 | 
						|
   :inherited-members:
 | 
						|
 | 
						|
   {% block methods %}
 | 
						|
   .. automethod:: __init__
 | 
						|
 | 
						|
   {% if methods %}
 | 
						|
   .. rubric:: {{ _('Methods') }}
 | 
						|
 | 
						|
   .. autosummary::
 | 
						|
   {% for item in methods %}
 | 
						|
      ~{{ name }}.{{ item }}
 | 
						|
   {%- endfor %}
 | 
						|
   {% endif %}
 | 
						|
   {% endblock %}
 | 
						|
 | 
						|
   {% block attributes %}
 | 
						|
   {% if attributes %}
 | 
						|
   .. rubric:: {{ _('Attributes') }}
 | 
						|
 | 
						|
   .. autosummary::
 | 
						|
   {% for item in attributes %}
 | 
						|
      ~{{ name }}.{{ item }}
 | 
						|
   {%- endfor %}
 | 
						|
   {% endif %}
 | 
						|
   {% endblock %}
 |