- 21 May, 2019 3 commits
-
-
Paul Beesley authored
Previously the readme.rst file served as the entrypoint for the documentation. With a Sphinx build the top-level document is set to be index.rst as it contains the primary document index. This patch moves some content from readme.rst into index.rst and splits the license information out into license.rst. Change-Id: I5c50250b81136fe36aa9ceedaae302b44ec11e47 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
-
Paul Beesley authored
This change creates the following directories under docs/ in order to provide a grouping for the content: - components - design - getting_started - perf - process In each of these directories an index.rst file is created and this serves as an index / landing page for each of the groups when the pages are compiled. Proper layout of the top-level table of contents relies on this directory/index structure. Without this patch it is possible to build the documents correctly with Sphinx but the output looks messy because there is no overall hierarchy. Change-Id: I3c9f4443ec98571a56a6edf775f2c8d74d7f429f Signed-off-by: Paul Beesley <paul.beesley@arm.com>
-
Paul Beesley authored
Add the essentials for supporting a Sphinx documentation build: - A makefile under docs/ to invoke Sphinx with the desired output format - A Sphinx master configuration file (conf.py) - A single, top-level index page (index.rst) - The TF.org logo that is integrated in the the sidebar of the rendered output Change-Id: I85e67e939658638337ca7972936a354878083a25 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
-