rtpengine

Commit Graph

Author	SHA1	Message	Date
Donat Zenichev	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
Donat Zenichev	0330d9a826	MT#55897 Fix images for the RTD Deprecate `asserts/` as it's only used for keeping images now. (github wiki links fixed accordingly) Create `docs/images` to keep visual materials and to properly link them from the RTD with markdown. Change-Id: Icbb8b22c57e087a57495b37bd7ecd1a15de05b43 (cherry picked from commit 99e0d936503a9026dbd55e2e0606b45853abb53b)	3 years ago
Donat Zenichev	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
Richard Fuchs	eb889aa2a9	MT#55897 list myst_parser as dep for readthedocs Change-Id: I167fa3365c78e805eb22f09635aa41155a796268	3 years ago
Donat Zenichev	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

5 Commits (ea651223dac656236c8630dad8d6397bbe0b290d)