wheels docs serve
Serves generated documentation locally for development and review.
Usage
wheels docs serve [--root=<dir>] [--port=<port>] [--open] [--watch]
Parameters
--root
- (Optional) Root directory to serve. Default:docs/api
--port
- (Optional) Port to serve on. Default:35729
--open
- (Optional) Open browser automatically. Default:true
--watch
- (Optional) Watch for changes and regenerate. Default:false
Description
The docs serve
command starts a local web server to preview your generated documentation.
Examples
Basic documentation server
wheels docs serve
Serve on different port
wheels docs serve --port=8080
Serve from custom directory
wheels docs serve --root=public/api-docs
Serve with file watching
wheels docs serve --watch
Serve without opening browser
wheels docs serve --open=false
Custom configuration
wheels docs serve --root=docs/generated --port=3000 --watch
Server Output
Output directory: D:\Command Box\wheels\templates\base\src\docs\api\
CommandBox:src> wheels docs serve
√ | Starting Server
| √ | Setting site [wheels-docs-BBAA12EF-7A83-4D03-BD6DBFE4AC17C1F9] Profile to [development]
| √ | Loading CFConfig into server
Status: starting
Server is still starting... waiting...
Server is up and running!
Starting documentation server...
Documentation server started!
Serving: D:\Command Box\wheels\templates\base\src\docs\api\
URL: http://localhost:35729
Opening browser...
Press Ctrl+C to stop the server
If documentation is not found:
Documentation directory not found: /docs/api
💡 Tip: Run 'wheels docs generate' first to create documentation
Features
File Watching
When --watch
is enabled, the server monitors documentation files for changes and can trigger regeneration.
Browser Integration
With --open=true
(default), the server automatically opens your default browser to the documentation URL.
Development Workflow
Typical usage:
# Step 1: Generate documentation
wheels docs generate
# Step 2: Serve documentation
wheels docs serve
# Step 3: Make changes and regenerate
wheels docs generate
# Browser will show updated docs
Custom workflow:
# Generate and serve from custom location
wheels docs generate --output=public/docs
wheels docs serve --root=public/docs --port=8080
Troubleshooting
Port already in use
# Use a different port
wheels docs serve --port=8081
Documentation not found
# Make sure to generate docs first
wheels docs generate
wheels docs serve
Browser doesn't open
# Manually navigate to the URL shown
# Or check your default browser settings
Notes
Server is intended for development/review only
For production, deploy static files to web server
Large documentation sets may take time to generate
Offline mode caches documentation locally
Last updated
Was this helpful?