| Author | SHA1 | Message | Date |
|---|---|---|---|
|
|
b98329f74f |
MT#55897 Restructure general README.md
We have to restructure project's general README.md in order to make all recently added documentation sources (including RTD) be compliant and let it look centralized and good organized. The root of the repository still has the README.md, but it only shows general summary on the project and then gives links to the extended documentation sources: - RTD stored - GitHub stored Change-Id: Ief160669432ecb3e22df16d9278df863da995991 |
3 years ago |
|
|
b1f1d6ad73 |
MT#55897 RTD: unify titling, achnoring, chapters
We have to unify the approach we use for setting these main blocks of the documentation to let it: 1) be unified; 2) be compliant with RTD. Change-Id: Ifc1f491c14688f0151429a80c8a0cfb1e6a22aaa |
3 years ago |
|
|
035de2c8ca |
MT#55897 Introduce Read the Docs
This is a first commit introducing general readthedocs wiki structure. It introduced the following main chapters: - Overview (is a symlink to the README.md), the readthedocs parses the markdown from here and creates the overview page - Architecture overview (with the sources taken from the git wiki) - Unit-tests (with the sources taken from the git wiki) - Troubleshooting Overview (now only memory leaks) - Glossary (doesn't have much information for now) Change-Id: I1a7db7ab1b169a5d002d251debbe1ad0f5d195ce |
3 years ago |