mirror of
				https://github.com/espressif/esp-protocols.git
				synced 2025-11-04 00:21:37 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			24 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			Plaintext
		
	
	
		
			Executable File
		
	
	
	
	
			
		
		
	
	
			24 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			Plaintext
		
	
	
		
			Executable File
		
	
	
	
	
# Cleanup the generated html
 | 
						|
rm -rf html
 | 
						|
 | 
						|
# Cleans example and test build dirs (to reduce the component size before upload)
 | 
						|
rm -rf ../examples/ap_to_pppos/build/ ../examples/simple_cmux_client/build/ ../examples/pppos_client/build/ ../examples/linux_modem/build/ ../examples/modem_console/build ../test/host_test/build/ ../test/target/build/
 | 
						|
 | 
						|
# Generate C++ API header of the DCE
 | 
						|
cat ../include/generate/esp_modem_command_declare.inc | clang++ -E -P -CC  -xc++ -I../include -DGENERATE_DOCS  - | sed -n '1,/DCE command documentation/!p' > esp_modem_dce.hpp
 | 
						|
 | 
						|
# Generate C API header of the modem_api.h
 | 
						|
cat ../include/generate/esp_modem_command_declare.inc | clang -E -P -CC  -xc -I../include -DGENERATE_DOCS  - | sed -n '1,/DCE command documentation/!p' > esp_modem_api_commands.h
 | 
						|
 | 
						|
# RST with links to C++ API
 | 
						|
cat ../include/generate/esp_modem_command_declare.inc | clang -E -P  -xc -I../include -DGENERATE_DOCS -DGENERATE_RST_LINKS - | sed 's/NL/\n/g' > cxx_api_links.rst
 | 
						|
 | 
						|
# Run doxygen
 | 
						|
doxygen
 | 
						|
 | 
						|
# Generate the docs
 | 
						|
python -u -m sphinx.cmd.build -b html  . html
 | 
						|
 | 
						|
# Cleanup the doxygen xml's and temporary headers
 | 
						|
rm -rf xml esp_modem_api_commands.h esp_modem_dce.hpp cxx_api_links.rst
 |