Add initial API doc configuration
Signed-off-by: David Horstmann <david.horstmann@arm.com>
This commit is contained in:
parent
4425383aaa
commit
e84d61cb64
6 changed files with 194 additions and 0 deletions
20
docs/Makefile
Normal file
20
docs/Makefile
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line, and also
|
||||||
|
# from the environment for the first two.
|
||||||
|
SPHINXOPTS ?=
|
||||||
|
SPHINXBUILD ?= sphinx-build
|
||||||
|
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)
|
34
docs/conf.py
Normal file
34
docs/conf.py
Normal file
|
@ -0,0 +1,34 @@
|
||||||
|
# Configuration file for the Sphinx documentation builder.
|
||||||
|
#
|
||||||
|
# For the full list of built-in configuration values, see the documentation:
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||||
|
|
||||||
|
# -- Project information -----------------------------------------------------
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||||
|
import glob
|
||||||
|
|
||||||
|
project = 'Mbed TLS Versioned'
|
||||||
|
copyright = '2023, Mbed TLS Contributors'
|
||||||
|
author = 'Mbed TLS Contributors'
|
||||||
|
|
||||||
|
# -- General configuration ---------------------------------------------------
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||||
|
|
||||||
|
extensions = ['breathe', 'sphinx.ext.graphviz']
|
||||||
|
|
||||||
|
templates_path = ['_templates']
|
||||||
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||||
|
|
||||||
|
breathe_projects = {
|
||||||
|
'mbedtls-versioned': '../apidoc/xml'
|
||||||
|
}
|
||||||
|
breathe_default_project = 'mbedtls-versioned'
|
||||||
|
|
||||||
|
primary_domain = 'c'
|
||||||
|
highlight_language = 'c'
|
||||||
|
|
||||||
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||||
|
|
||||||
|
html_theme = 'sphinx_rtd_theme'
|
||||||
|
html_static_path = ['_static']
|
20
docs/index.rst
Normal file
20
docs/index.rst
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
.. Mbed TLS Versioned documentation master file, created by
|
||||||
|
sphinx-quickstart on Thu Feb 23 18:13:44 2023.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Mbed TLS API documentation
|
||||||
|
==========================
|
||||||
|
|
||||||
|
.. doxygenpage:: index
|
||||||
|
:project: mbedtls-versioned
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:caption: Contents
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Home <self>
|
||||||
|
api/grouplist.rst
|
||||||
|
api/filelist.rst
|
||||||
|
api/structlist.rst
|
||||||
|
api/unionlist.rst
|
35
docs/make.bat
Normal file
35
docs/make.bat
Normal file
|
@ -0,0 +1,35 @@
|
||||||
|
@ECHO OFF
|
||||||
|
|
||||||
|
pushd %~dp0
|
||||||
|
|
||||||
|
REM Command file for Sphinx documentation
|
||||||
|
|
||||||
|
if "%SPHINXBUILD%" == "" (
|
||||||
|
set SPHINXBUILD=sphinx-build
|
||||||
|
)
|
||||||
|
set SOURCEDIR=.
|
||||||
|
set BUILDDIR=_build
|
||||||
|
|
||||||
|
%SPHINXBUILD% >NUL 2>NUL
|
||||||
|
if errorlevel 9009 (
|
||||||
|
echo.
|
||||||
|
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||||
|
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||||
|
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||||
|
echo.may add the Sphinx directory to PATH.
|
||||||
|
echo.
|
||||||
|
echo.If you don't have Sphinx installed, grab it from
|
||||||
|
echo.https://www.sphinx-doc.org/
|
||||||
|
exit /b 1
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "" goto help
|
||||||
|
|
||||||
|
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||||
|
goto end
|
||||||
|
|
||||||
|
:help
|
||||||
|
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||||
|
|
||||||
|
:end
|
||||||
|
popd
|
3
docs/requirements.in
Normal file
3
docs/requirements.in
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
sphinx-rtd-theme
|
||||||
|
breathe
|
||||||
|
exhale
|
82
docs/requirements.txt
Normal file
82
docs/requirements.txt
Normal file
|
@ -0,0 +1,82 @@
|
||||||
|
#
|
||||||
|
# This file is autogenerated by pip-compile with Python 3.8
|
||||||
|
# by the following command:
|
||||||
|
#
|
||||||
|
# pip-compile requirements.in
|
||||||
|
#
|
||||||
|
alabaster==0.7.13
|
||||||
|
# via sphinx
|
||||||
|
babel==2.12.1
|
||||||
|
# via sphinx
|
||||||
|
beautifulsoup4==4.11.2
|
||||||
|
# via exhale
|
||||||
|
breathe==4.35.0
|
||||||
|
# via
|
||||||
|
# -r requirements.in
|
||||||
|
# exhale
|
||||||
|
certifi==2022.12.7
|
||||||
|
# via requests
|
||||||
|
charset-normalizer==3.1.0
|
||||||
|
# via requests
|
||||||
|
docutils==0.17.1
|
||||||
|
# via
|
||||||
|
# breathe
|
||||||
|
# exhale
|
||||||
|
# sphinx
|
||||||
|
# sphinx-rtd-theme
|
||||||
|
exhale==0.3.6
|
||||||
|
# via -r requirements.in
|
||||||
|
idna==3.4
|
||||||
|
# via requests
|
||||||
|
imagesize==1.4.1
|
||||||
|
# via sphinx
|
||||||
|
importlib-metadata==6.0.0
|
||||||
|
# via sphinx
|
||||||
|
jinja2==3.1.2
|
||||||
|
# via sphinx
|
||||||
|
lxml==4.9.2
|
||||||
|
# via exhale
|
||||||
|
markupsafe==2.1.2
|
||||||
|
# via jinja2
|
||||||
|
packaging==23.0
|
||||||
|
# via sphinx
|
||||||
|
pygments==2.14.0
|
||||||
|
# via sphinx
|
||||||
|
pytz==2022.7.1
|
||||||
|
# via babel
|
||||||
|
requests==2.28.2
|
||||||
|
# via sphinx
|
||||||
|
six==1.16.0
|
||||||
|
# via exhale
|
||||||
|
snowballstemmer==2.2.0
|
||||||
|
# via sphinx
|
||||||
|
soupsieve==2.4
|
||||||
|
# via beautifulsoup4
|
||||||
|
sphinx==4.5.0
|
||||||
|
# via
|
||||||
|
# breathe
|
||||||
|
# exhale
|
||||||
|
# sphinx-rtd-theme
|
||||||
|
sphinx-rtd-theme==1.2.0
|
||||||
|
# via -r requirements.in
|
||||||
|
sphinxcontrib-applehelp==1.0.4
|
||||||
|
# via sphinx
|
||||||
|
sphinxcontrib-devhelp==1.0.2
|
||||||
|
# via sphinx
|
||||||
|
sphinxcontrib-htmlhelp==2.0.1
|
||||||
|
# via sphinx
|
||||||
|
sphinxcontrib-jquery==2.0.0
|
||||||
|
# via sphinx-rtd-theme
|
||||||
|
sphinxcontrib-jsmath==1.0.1
|
||||||
|
# via sphinx
|
||||||
|
sphinxcontrib-qthelp==1.0.3
|
||||||
|
# via sphinx
|
||||||
|
sphinxcontrib-serializinghtml==1.1.5
|
||||||
|
# via sphinx
|
||||||
|
urllib3==1.26.15
|
||||||
|
# via requests
|
||||||
|
zipp==3.15.0
|
||||||
|
# via importlib-metadata
|
||||||
|
|
||||||
|
# The following packages are considered to be unsafe in a requirements file:
|
||||||
|
# setuptools
|
Loading…
Reference in a new issue