[refactor] Direct reference for existing project docs #96
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.



Motivation
Related issue: #95
The goal of this refactoring is to reduce the maintenance cost of the documentation.
The specific principle is: if an open-source project provides comprehensive NPU usage documentation,
Ascend/docsshould directly link to and stay synchronized with this documentation.Using the
verlproject as an example, I will explain how to implement this.Method
Here, the
verlproject is used for demonstration.git submoduleto add the subproject toAscend/docs. The benefits include:Ascend/docsfrom becoming bloated by including entire projects.index.rstfile in thesources/verlfolder to serve as the table of contents for theverlproject documentation. This allows users to control the scope of the documentation displayed. In other words, if users do not wish to display all of verl's documentation inAscend/docs, they can manage this via theindex.rstfile.Makefile:make html.VeOmniproject as an example, I have added a warning prompt that triggers if the directory is empty.