apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-04-25 00:36:34 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Docs branch - v1 of our tech docs (#69)

Browse source 
* added the first set of docs for our technical docs

* more docuemtnation changes

* added support for prompt processing and updated life of a request

* updated docs to including getting help sections and updated life of a request

* committing local changes for getting started guide, sample applications, and full reference spec for prompt-config

* updated configuration reference, added sample app skeleton, updated favico

* fixed the configuration refernce file, and made minor changes to the intent detection. commit v1 for now

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
Co-authored-by: Adil Hafeez <adil@katanemo.com>
This commit is contained in:
Salman Paracha 2024-09-20 17:08:42 -07:00 • committed by GitHub
parent 233976a568
commit 80c554ce1a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
34 changed files with 1040 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

55
docs/source/conf.py Normal file
View file

@ -0,0 +1,55 @@
# 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
project = 'Arch'
copyright = '2024, Katanemo Labs, Inc'
author = 'Katanemo Labs, Inc'
release = '0.1-beta'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
root_doc = 'root'
# -- General configuration ---------------------------------------------------
extensions = [
'sphinx.ext.autodoc', # For generating documentation from docstrings
'sphinx.ext.napoleon', # For Google style and NumPy style docstrings
'sphinx_copybutton',
'sphinx.ext.viewcode',
]
# Paths that contain templates, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and directories
# to ignore when looking for source files.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
html_favicon = '_static/favicon.ico'
# -- Options for HTML output -------------------------------------------------
html_theme = 'sphinx_rtd_theme' # You can change the theme to 'sphinx_rtd_theme' or another of your choice.
# Specify the path to the logo image file (make sure the logo is in the _static directory)
html_logo = '_static/img/arch-logo.png'
html_theme_options = {
'logo_only': True,
'includehidden': False,
'navigation_depth': 4,
'collapse_navigation': False,
}
# 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_style = 'css/arch.css'