Skip to content

Commit 2593254

Browse files
adding documentation
1 parent ab72dde commit 2593254

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+26282
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Deploy MkDocs site to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main # Change to your default branch if different
7+
8+
jobs:
9+
build-deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Check out repository
13+
uses: actions/checkout@v2
14+
15+
- name: Set up Python
16+
uses: actions/setup-python@v2
17+
with:
18+
python-version: '3.x'
19+
20+
- name: Install dependencies
21+
run: |
22+
pip install mkdocs mkdocs-material
23+
24+
- name: Deploy to GitHub Pages
25+
run: |
26+
mkdocs gh-deploy --force

img/globe_with_meridians.png

23.3 KB
Loading

mkdocs.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
site_name: GenSphere Documentation
2+
site_description: Official documentation for GenSphere, a declarative framework to build LLM applications.
3+
site_author: Octopus2023 Inc.
4+
repo_url: https://github.com/octopus2023-inc/gensphere
5+
nav:
6+
- Introduction: index.md
7+
- Getting Started:
8+
- Installation: getting_started/installation.md
9+
- Quickstart Guide: getting_started/quickstart.md
10+
- Tutorials:
11+
-Quickstart Tutorial: tutorials/tutorial.md
12+
- User Guide:
13+
- Workflows: user_guide/workflows.md
14+
- Functions and Schemas: user_guide/functions_and_schemas.md
15+
- Nesting workflows: user_guide/nesting_workflows.md
16+
- Integration with Composio and Langchain tools: user_guide/integration_with_composio_and_langchain.md
17+
- Lists and iterables: user_guide/lists_and_iterables.md
18+
- Visualization: user_guide/visualization.md
19+
- Execution: user_guide/execution.md
20+
- API Reference:
21+
- API reference: api_reference/api_reference.md
22+
theme:
23+
name: material
24+
logo: img/globe_with_meridians.png
25+
favicon: img/globe_with_meridians.png
26+
palette:
27+
- scheme: default
28+
primary: 'indigo'
29+
accent: 'indigo'
30+
features:
31+
- navigation.expand
32+
- navigation.sections
33+
- navigation.top
34+
- navigation.tracking
35+
- toc.integrate
36+
- instant
37+
markdown_extensions:
38+
- admonition
39+
- codehilite
40+
- footnotes
41+
- tables
42+
- toc:
43+
permalink: true
44+
extra_css:
45+
- css/custom.css
46+
extra_javascript:
47+
- js/custom.js
48+
plugins:
49+
- search
50+
- git-revision-date-localized:
51+
locale: en
52+
timezone: UTC

0 commit comments

Comments
 (0)