Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

manhattanreasoning-docs

User documentation for Manhattan Reasoning, built with MkDocs Material + mkdocstrings.

Published via GitHub Pages at https://docs.manhattanreasoning.com.

Structure

  • docs/ — quickstart, SDK/CLI guides, examples, and the API reference
  • docs/reference/api.md — the Python API reference, auto-generated by mkdocstrings from the public manhattan-reasoning-gym source
  • mkdocs.yml — site config
  • .github/workflows/deploy.yml — builds and deploys on every push to main

Local development

The Python API reference reads the SDK source from the public manhattan-reasoning-gym repo, checked out into _code/ (no auth needed — it's public):

python3 -m venv .venv && source .venv/bin/activate
pip install -r docs-requirements.txt
./scripts/fetch-code.sh      # clones manhattan-reasoning-gym into _code/
mkdocs serve

Deploys

Pushing to main triggers the deploy workflow, which checks out this repo plus the public manhattan-reasoning-gym source, runs mkdocs build --strict, and publishes the result to the gh-pages branch.

To rebuild when the SDK changes, manhattan-reasoning-gym can dispatch a code-updated event to this repo's deploy workflow.

About

User documentation for manhattanreasoning.com (MkDocs Material)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages