15 lines
		
	
	
	
		
			423 B
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			15 lines
		
	
	
	
		
			423 B
		
	
	
	
		
			Markdown
		
	
	
	
	
	
# BigDL Documentation
 | 
						|
 | 
						|
To compile the documentation, run the following commands from this directory.
 | 
						|
 | 
						|
```
 | 
						|
pip install -r requirements-doc.txt
 | 
						|
pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
 | 
						|
make html
 | 
						|
open _build/html/index.html
 | 
						|
```
 | 
						|
 | 
						|
To test if there are any build errors with the documentation, do the following.
 | 
						|
 | 
						|
```
 | 
						|
sphinx-build -b html -d _build/doctrees source _build/html
 |