Giter Site home page Giter Site logo

documents's Introduction

编写项目文档

所有与项目相关的文档,包括:项目介绍、项目管理、版本说明、贡献方式、技术标准等,都以reStructuredText(rst)格式提供,并放在source目录下。

一些有关rst文档格式的说明可以参考以下文档:

http://www.pythondoc.com/sphinx/rest.html

https://www.cnblogs.com/seayxu/p/5603876.html

https://docutils.readthedocs.io/en/sphinx-docs/user/rst/quickstart.html

https://docutils.readthedocs.io/en/sphinx-docs/ref/rst/directives.html

编译html文档

这些项目文档可以通过以下方式编译成html文件,并方便的通过浏览器进行浏览。

在编译之前需要预先安装以下软件:

  • Python3
  • Pip

然后运行如下命令,成功后用浏览器打开 build/html/index.html 进行阅读:

make all

documents's People

Contributors

dipei2020 avatar genggjh avatar hukunge avatar kiwiqiqi avatar zhangbing16 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

documents's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.