Linux kernel
============
There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.
In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``. The formatted documentation can also be read online at:
https://www.kernel.org/doc/html/latest/
There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.
Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.
“87920dd4d93924a4b4aba01078ab606406649a82”上不存在“git@gitcode.net:openeuler/raspberrypi-kernel.git”
MindSpore Documents
Overview
Contributions
Directory Structure Description
Document Construction
License
README.md
MindSpore Documents
Overview
This project provides the source files of the installation guide, tutorials, and other documents, as well as API configurations on the MindSpore official website https://www.mindspore.cn.
Contributions
You are welcome to contribute documents. If you want to contribute documents, read the CONTRIBUTING_DOC.md. Please comply with the document writing specifications, and submit documents according to the process rules. After the documents are approved, the changes will be displayed in the document project and on the official website.
If you have any comments or suggestions on the documents, submit them in Issues.
Directory Structure Description
docs
├───api // Configuration files for API generation.
│
├───docs // Technical documents about architecture, network list, operator list, and so on.
│
├───install // Installation guide.
│
├───resource // Resource-related documents.
│
├───tutorials // Tutorial-related documents.
│
└───README.md // Docs repository description.Document Construction
MindSpore tutorials and API documents can be generated by Sphinx. The following uses the API document as an example to describe the procedure, and ensure that MindSpore, MindInsight and MindArmour have been installed.
- Download code of the MindSpore Docs repository.
git clone https://gitee.com/mindspore/docs.git - Go to the api directory and install the dependency items in the
requirements.txtfile.cd docs/api pip install -r requirements.txt - Run the following command in the api directory to create the
build_zh_cn/htmldirectory that stores the generated document web page. You can openbuild_zh_cn/html/index.htmlto view the API document.make htmlIf you only need to generate the MindSpore API, please modify the
source_zh_cn/conf.pyfile, comment theimport mindinsightandimport mindarmourstatements, and then perform this step.
