From 17a104b093cc7c84c5fe63ce2b1629c3e8dc22a6 Mon Sep 17 00:00:00 2001 From: SyedAhkam Date: Tue, 15 Nov 2022 02:23:28 +0530 Subject: [PATCH 1/2] docs: Configure redoc --- docs/conf.py | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index aac7037..e29ace8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,8 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information +import sphinx_rtd_theme + project = 'Eye' copyright = '2022, 0x0elliot, SyedAhkam' author = '0x0elliot, SyedAhkam' @@ -14,15 +16,26 @@ # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = [] +extensions = [ + 'sphinxcontrib.redoc', + 'sphinx_rtd_theme' +] templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' html_static_path = ['_static'] + +redoc = [ + { + 'name': 'Eye API', + 'page': 'api-doc', + 'spec': 'schema.yml', + 'embed': True, + } +] \ No newline at end of file From 2ebef75ed57a4375b7af414b646cbb08cbe73f38 Mon Sep 17 00:00:00 2001 From: SyedAhkam Date: Tue, 15 Nov 2022 02:24:08 +0530 Subject: [PATCH 2/2] docs: add sphinx deps to dev-requirements --- requirements/dev-requirements.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/requirements/dev-requirements.txt b/requirements/dev-requirements.txt index e23a8ef..d6ec6da 100644 --- a/requirements/dev-requirements.txt +++ b/requirements/dev-requirements.txt @@ -16,3 +16,6 @@ black==22.3.0 isort==5.10.1 pre-commit==2.19.0 coverage==6.4 +sphinx +sphinxcontrib-redoc +sphinx_rtd_theme \ No newline at end of file