Skip to content

donghaiwang/carla_doc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Carla 中文文档

文档主页

本地部署并测试

  1. 使用pip安装mkdocs
pip install mkdocs

(可选)安装完成后使用mkdocs --version查看是否安装成功。

  1. 在命令行中进入carla_doc目录下,运行:
mkdocs build
mkdocs serve

然后使用浏览器打开 http://127.0.0.1:8000,查看文档页面能否正常显示。

  1. 部署到github
mkdocs gh-deploy

该命令会自动将相应内容推送到项目的gh-pages分支上,然后在 Github 项目设置中选择好对应 GitPage 的分支,目录选择/(root)(注意不要是/(docs),然后通过 https://openhutb.github.io/carla_doc/ 访问即可。

使用虚拟环境会出现找不到git的错误,请添加git的环境变量:

set path=%path%;C:\Program Files\Git\cmd\
  1. 删除页脚(可选)
  • 克隆删除页脚的mkdocs仓库(删除mkdocs/themes/readthedocs /footer.html文件中的页脚内容):
git clone https://github.com/OpenHUTB/mkdocs.git

安装mkdocs包:

python -m pip install .

然后使用新的mkdocs执行步骤1-3。

问题

ERROR - Config value: ‘plugins‘. Error: The “redirects“ plugin is not installed

解决

pip install redirects

编译出错解决:

Config value: 'markdown_extensions'. Error: Failed loading extension "mdx_gh_links".

手动安装库

pip install mdx_gh_links

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.2%
  • Batchfile 1.8%