Skip to content

如何参与Geniatech项目(how to contribute)

License

Notifications You must be signed in to change notification settings

hnzqd/geniatech_guide

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

关于本项目

本项目的github地址:https://github.com/Geniatech-zhou/geniatech_guide.git

点击右侧链接可在线阅读本项目文档:《 [Geniatech]sphinx文档规范与模版

本文档是关于如何使用sphinx编写文档的说明。 也可以把本文档作为模版创建其它sphinx的文档。

为什么使用sphinx编写文档

使用shpinx编写文档有如下优点:

  • 使用sphinx编写的文档可以方便地制作html、pdf等格式,非常方便浏览和转换。
  • sphinx支持rst和markdown语法,方便共享及开源编辑,使用git也方便跟踪。
  • 由于rst语法比markdown语法更强大和方便,我们主要采用rst语法编写文档, linux内核源码文档也是使用rst格式编写的。 我们的文档也支持markdown,主要是为了方便不熟悉rst的用户参与进来。

About

如何参与Geniatech项目(how to contribute)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 64.5%
  • Makefile 28.7%
  • Shell 6.8%