Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
adam.huang
Arm Trusted Firmware
Commits
12b67439
Commit
12b67439
authored
5 years ago
by
Sandrine Bailleux
Committed by
TrustedFirmware Code Review
5 years ago
Browse files
Options
Download
Plain Diff
Merge "doc: Add minimal Sphinx support" into integration
parents
62a72942
653279b0
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
docs/Makefile
+25
-0
docs/Makefile
docs/conf.py
+72
-0
docs/conf.py
docs/index.rst
+47
-0
docs/index.rst
docs/resources/TrustedFirmware-Logo_standard-white.png
+0
-0
docs/resources/TrustedFirmware-Logo_standard-white.png
with
144 additions
and
0 deletions
+144
-0
docs/Makefile
0 → 100644
View file @
12b67439
#
# Copyright (c) 2019, ARM Limited. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS
=
SPHINXBUILD
=
sphinx-build
SPHINXPROJ
=
TrustedFirmware-A
SOURCEDIR
=
.
BUILDDIR
=
build
# Put it first so that "make" without argument is like "make help".
help
:
@
$(SPHINXBUILD)
-M
help
"
$(SOURCEDIR)
"
"
$(BUILDDIR)
"
$(SPHINXOPTS)
$(O)
.PHONY
:
help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%
:
Makefile
@
$(SPHINXBUILD)
-M
$@
"
$(SOURCEDIR)
"
"
$(BUILDDIR)
"
$(SPHINXOPTS)
$(O)
This diff is collapsed.
Click to expand it.
docs/conf.py
0 → 100644
View file @
12b67439
# -*- coding: utf-8 -*-
#
# Copyright (c) 2019, Arm Limited. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
#
# Configuration file for the Sphinx documentation builder.
#
# See the options documentation at http://www.sphinx-doc.org/en/master/config
# -- Project information -----------------------------------------------------
project
=
'Trusted Firmware-A'
version
=
'2.1'
release
=
version
# We don't need these to be distinct
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions
=
[]
# Add any paths that contain templates here, relative to this directory.
templates_path
=
[
'_templates'
]
# The suffix(es) of source filenames.
source_suffix
=
'.rst'
# The master toctree document.
master_doc
=
'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language
=
None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns
=
[]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style
=
'sphinx'
# -- Options for HTML output -------------------------------------------------
# Don't show the "Built with Sphinx" footer
html_show_sphinx
=
False
# Don't show copyright info in the footer (we have this content in the page)
html_show_copyright
=
False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme
=
"sphinx_rtd_theme"
# The logo to display in the sidebar
html_logo
=
'resources/TrustedFirmware-Logo_standard-white.png'
# Options for the "sphinx-rtd-theme" theme
html_theme_options
=
{
'collapse_navigation'
:
False
,
# Can expand and collapse sidebar entries
'prev_next_buttons_location'
:
'both'
,
# Top and bottom of the page
'style_external_links'
:
True
# Display an icon next to external links
}
This diff is collapsed.
Click to expand it.
docs/index.rst
0 → 100644
View file @
12b67439
Arm Trusted Firmware-A Documentation Index
==========================================
.. toctree::
:maxdepth: 1
:caption: Design Documents
arm-sip-service
auth-framework
.. toctree::
:maxdepth: 1
:caption: Release Notes
change-log
.. toctree::
:maxdepth: 1
:caption: Guides
.. toctree::
:maxdepth: 1
:caption: Policies
cpu-specific-build-macros
exception-handling
firmware-design
firmware-update
interrupt-framework-design
platform-compatibility-policy
platform-interrupt-controller-API
porting-guide
psci-lib-integration-guide
psci-pd-tree
ras
reset-design
rt-svc-writers-guide
sdei
secure-partition-manager-design
trusted-board-boot
user-guide
xlat-tables-lib-v2-design
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
This diff is collapsed.
Click to expand it.
docs/resources/TrustedFirmware-Logo_standard-white.png
0 → 100644
View file @
12b67439
5.69 KB
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
Menu
Projects
Groups
Snippets
Help