docs: enable rtd theme

This commit is contained in:
Alex Kelly 2021-10-04 12:18:43 -04:00
parent 667e1c174e
commit 7326894353
4 changed files with 34 additions and 8 deletions

View file

@ -16,13 +16,14 @@
# -- Project information -----------------------------------------------------
import sphinx_rtd_theme
project = 'checkcert'
copyright = '2021, Alex Kelly'
author = 'Alex Kelly'
project = "checkcert"
copyright = "2021, Alex Kelly"
author = "Alex Kelly"
# The full version, including alpha/beta/rc tags
release = '0.5.0'
release = "0.5.0"
# -- General configuration ---------------------------------------------------
@ -31,10 +32,11 @@ release = '0.5.0'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx_rtd_theme",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
@ -47,9 +49,9 @@ exclude_patterns = []
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ["_static"]

View file

@ -0,0 +1,4 @@
Introduction
============
checkcert is a CLI to check a remote site secured with a certificate. It will allow you to get basic information about the certificate, if it is currently valid, any subjectAlternateNames that are present, and output content for ingestion into other utilities