Skip to content

Latest commit

 

History

History

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

introduce

install dependencies

pip install -r requirements.txt

Modify the content of the document

Built with the mkdocs tool, the document structure is defined in the mkdocs.yml file, and the specific content of the document is in the docs directory.

This document is edited in markdown syntax. If new documents need to be added, please edit mkdocs.yaml and add chapters.

Local debugging documentation

mkdocs serve -a 127.0.0.1:8030

After executing the above command, you can view the content of the generated document through the http://127.0.0.1:8030 address.

When the document is modified, the page content will be updated automatically.

Local build documentation

mkdocs build

After executing the above command, the static files of the documentation site will be generated in the site directory, and the generated static files can be accessed by proxy.