mirror of
				https://github.com/inventree/InvenTree.git
				synced 2025-10-31 05:05:42 +00:00 
			
		
		
		
	Use sphinx-autoapi to generate documentation files
- Select which files to ignore - Only display items with a docstring
This commit is contained in:
		
							
								
								
									
										22
									
								
								docs/conf.py
									
									
									
									
									
								
							
							
						
						
									
										22
									
								
								docs/conf.py
									
									
									
									
									
								
							| @@ -28,14 +28,24 @@ copyright = '2019, InvenTree' | ||||
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||||
| # ones. | ||||
| extensions = [ | ||||
|     'sphinx.ext.coverage', | ||||
|     'sphinx.ext.napoleon', | ||||
|     'sphinx.ext.viewcode', | ||||
|     'autoapi.extension' | ||||
| ] | ||||
|  | ||||
| napoleon_google_docstring = False | ||||
| napoleon_use_param = False | ||||
| napoleon_use_ivar = True | ||||
| autoapi_dirs = [ | ||||
|     '../InvenTree', | ||||
| ] | ||||
|  | ||||
| autoapi_options = [ | ||||
|     'members', | ||||
| ] | ||||
|  | ||||
| autoapi_type = 'python' | ||||
|  | ||||
| autoapi_ignore = [ | ||||
|     '*migrations*', | ||||
|     '**/test*.py', | ||||
|     '**/manage.py' | ||||
| ] | ||||
|  | ||||
| # Add any paths that contain templates here, relative to this directory. | ||||
| templates_path = ['_templates'] | ||||
|   | ||||
| @@ -1,2 +1,3 @@ | ||||
| Sphinx>=2.0.1 | ||||
| sphinx_rtd_theme==0.4.3 | ||||
| sphinx-auto-api==1.0.0 | ||||
| sphinx-rtd-theme==0.4.3 | ||||
		Reference in New Issue
	
	Block a user