Technical documentation
文章平均质量分 94
本栏主要为了FPGA开发过程中,进行多人协作、技术文档编写更加快捷高效进行的分享!
JunFN8
Every experience in life is useful and every step is crucial !
展开
-
Sphinx环境配置以及VScode编写Rst文档转html
安装中可能会出现pip版本过低安装不了Sphinx,需运行命令更新pip再安装Spinx。国内最好用华清源安装,使用-i指定安装源。这些配置参数都可以在之后的conf.py文件中打开重新更改。多个文件时可用于连接其余文件。一个pythom文件,用于存放Sphinx的配置参数。用户可根据需求编写这两个文档达到自己的效果。存放最终生成的文档如html、pdf、ePub。批处理指令,使用make命令时用来构建文档输出。编写此类技术文档时Sphinx工具可将其转为。存放Rst格式等文件以及图片数据。原创 2023-03-18 00:21:57 · 1777 阅读 · 6 评论 -
Read the Docs托管 .Rst 格式文件到 GitHub
GitHub是什么?进入GitHub官网注册个人账户根据向导完成新用户创建即可,邮箱作者本人用的谷歌的;GitHub创建新仓库GitHub删除已创建的仓库下拉至底部手动输入用户名/仓库名,然后Delete仓库就删除完成了由此本文的分享结束了上述相关问题,欢迎探讨也欢迎指正!原创 2023-04-06 15:08:11 · 159 阅读 · 1 评论