mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-11-04 07:12:33 +01:00 
			
		
		
		
	[Docs] CLI command to serve docs locally (#6956)
* CLI command to serve docs locally * Document it * Default port * Use `with` and subclass `SimpleHTTPRequestHandler` to set working dir * Apply suggestions from code review Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Update docs/cli.md
This commit is contained in:
		
							parent
							
								
									e7d95701bf
								
							
						
					
					
						commit
						2707652c98
					
				
							
								
								
									
										10
									
								
								docs/cli.md
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								docs/cli.md
									
									
									
									
									
								
							@ -105,6 +105,16 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d
 | 
				
			|||||||
qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
 | 
					qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## `qmk docs`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Usage**:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					qmk docs [-p PORT]
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## `qmk doctor`
 | 
					## `qmk doctor`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This command examines your environment and alerts you to potential build or flash problems.
 | 
					This command examines your environment and alerts you to potential build or flash problems.
 | 
				
			||||||
 | 
				
			|||||||
@ -5,6 +5,7 @@ We list each subcommand here explicitly because all the reliable ways of searchi
 | 
				
			|||||||
from . import cformat
 | 
					from . import cformat
 | 
				
			||||||
from . import compile
 | 
					from . import compile
 | 
				
			||||||
from . import config
 | 
					from . import config
 | 
				
			||||||
 | 
					from . import docs
 | 
				
			||||||
from . import doctor
 | 
					from . import doctor
 | 
				
			||||||
from . import hello
 | 
					from . import hello
 | 
				
			||||||
from . import json
 | 
					from . import json
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										22
									
								
								lib/python/qmk/cli/docs.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								lib/python/qmk/cli/docs.py
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,22 @@
 | 
				
			|||||||
 | 
					"""Serve QMK documentation locally
 | 
				
			||||||
 | 
					"""
 | 
				
			||||||
 | 
					import http.server
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					from milc import cli
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					class DocsHandler(http.server.SimpleHTTPRequestHandler):
 | 
				
			||||||
 | 
					    def __init__(self, *args, **kwargs):
 | 
				
			||||||
 | 
					        super().__init__(*args, directory='docs', **kwargs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					@cli.argument('-p', '--port', default=8936, type=int, help='Port number to use.')
 | 
				
			||||||
 | 
					@cli.subcommand('Run a local webserver for QMK documentation.')
 | 
				
			||||||
 | 
					def docs(cli):
 | 
				
			||||||
 | 
					    """Spin up a local HTTPServer instance for the QMK docs.
 | 
				
			||||||
 | 
					    """
 | 
				
			||||||
 | 
					    with http.server.HTTPServer(('', cli.config.docs.port), DocsHandler) as httpd:
 | 
				
			||||||
 | 
					        cli.log.info("Serving QMK docs at http://localhost:%d/", cli.config.docs.port)
 | 
				
			||||||
 | 
					        cli.log.info("Press Control+C to exit.")
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        httpd.serve_forever()
 | 
				
			||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user