Skip to content

docs: configure redoc and use rtd-theme #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sedbytes merged 2 commits into from
Nov 14, 2022
Merged

docs: configure redoc and use rtd-theme #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17a104b
docs: Configure redoc
sedbytes Nov 14, 2022
2ebef75
docs: add sphinx deps to dev-requirements
sedbytes Nov 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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,
}
]
3 changes: 3 additions & 0 deletions requirements/dev-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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