Skip to content
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.

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

chore: Docs Structure #31

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
106 changes: 17 additions & 89 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,22 @@ site_url: https://rigging.dreadnode.io
repo_url: https://github.com/dreadnode/rigging

nav:
- Home:
- index.md
- Topics:
- Workflow: topics/workflow.md
- Models: topics/models.md
- Generators: topics/generators.md
- Chats and Messages: topics/chats-and-messages.md
- Prompt Functions: topics/prompt-functions.md
- Completions: topics/completions.md
- Callbacks and Mapping: topics/callbacks-and-mapping.md
- Iterating and Batching: topics/iterating-and-batching.md
- Tools: topics/tools.md
- Tracing: topics/tracing.md
- Serialization: topics/serialization.md
- Logging: topics/logging.md
- Migrations: topics/migrations.md
- Principles: topics/principles.md
- index.md
- Topics:
- Workflow: topics/workflow.md
- Models: topics/models.md
- Generators: topics/generators.md
- Chats and Messages: topics/chats-and-messages.md
- Prompt Functions: topics/prompt-functions.md
- Completions: topics/completions.md
- Callbacks and Mapping: topics/callbacks-and-mapping.md
- Iterating and Batching: topics/iterating-and-batching.md
- Tools: topics/tools.md
- Tracing: topics/tracing.md
- Serialization: topics/serialization.md
- Logging: topics/logging.md
- Migrations: topics/migrations.md
- Principles: topics/principles.md
- API:
- rigging.chat: api/chat.md
- rigging.completion: api/completion.md
Expand All @@ -38,76 +37,5 @@ nav:
- rigging.error: api/error.md
- rigging.util: api/util.md


theme:
logo: assets/logo_black.png
favicon: assets/logo_white.png
name: material
icon:
repo: fontawesome/brands/github
palette:
scheme: slate
primary: custom
features:
- content.code.copy
- content.code.annotate
- navigation.footer
- navigation.indexes
- navigation.sections
- navigation.expand
- navigation.path
- navigation.top
- navigation.tabs
- navigation.tabs.sticky

plugins:
- search
- section-index
- social
- mkdocstrings:
handlers:
python:
paths: [rigging]
options:
docstring_options:
ignore_init_summary: true
docstring_section_style: list
heading_level: 3
merge_init_into_class: true
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true

watch:
- rigging/

markdown_extensions:
- admonition
- pymdownx.highlight:
anchor_linenums: true
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: "#"

extra_css:
- stylesheets/extra.css

extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6

extra:
homepage: https://dreadnode.io
social:
- icon: fontawesome/brands/github
link: https://github.com/dreadnode
- icon: fontawesome/brands/twitter
link: https://twitter.com/dreadnode
- icon: fontawesome/brands/python
link: https://pypi.org/project/rigging/
- rigging/
Loading