update docs

Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
2021-12-15 03:54:43 -08:00
parent dfa76e9462
commit 059dc0e521
284 changed files with 14864 additions and 348 deletions

View File

@ -14,14 +14,15 @@ import os
import sys
sys.path.insert(1, os.path.dirname(os.path.abspath(__file__)))
sys.path.append(os.path.abspath('../kittycad'))
# -- Project information -----------------------------------------------------
project = 'kittycad'
copyright = '2021, KittyCAD Inc.'
author = 'KittyCAD Inc.'
author = 'KittyCAD Team Members'
copyright = author
# The full version, including alpha/beta/rc tags
# Get the version from the poetry file.
@ -30,8 +31,9 @@ import toml
with open(os.path.abspath('../pyproject.toml'), 'r') as f:
parsed_toml = toml.load(f)
version = parsed_toml['tool']['poetry']['version']
version = 'v'+version
release = 'v'+ version
release = version
# -- General configuration ---------------------------------------------------
@ -43,9 +45,15 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx_autodoc_typehints',
'sphinx.ext.intersphinx',
'sphinx.ext.linkcode'
'sphinx.ext.linkcode',
'sphinx_automodapi.automodapi',
'sphinx_rtd_theme'
]
numpydoc_show_class_members = False
automodapi_inheritance_diagram = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -60,13 +68,20 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# 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 themes here, relative to this directory.
html_theme_path = [
]
# 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 = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'trac'
# Intersphinx configuration.
# FROM: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx
intersphinx_mapping = {