Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
ycleptic 2.0.6 documentation
ycleptic 2.0.6 documentation
  • About
  • Installation
  • Usage
    • Yclept Class
    • The Base Configuration
    • The User Configuration
    • Interactive Help
    • Resource File
    • yclept config-help
    • yclept make-doc
  • API
    • ycleptic package
      • ycleptic.resources package
      • ycleptic.src package
        • ycleptic.src.dictthings module
        • ycleptic.src.makedoc module
        • ycleptic.src.stringthings module
        • ycleptic.src.walkers module
        • ycleptic.src.yclept module
      • ycleptic.cli module
  • Changelog
Back to top
View this page

UsageΒΆ

Ycleptic primarily exposes the ycleptic.yclept.Yclept class to inherit in your own applications. It also has a command-line interface with two subcommands: yclept config-help and yclept make-doc. The former provides interactive help for the configuration file, and the latter generates documentation from the base configuration file.

  • Yclept Class
  • The Base Configuration
  • The User Configuration
  • Interactive Help
  • Resource File
  • yclept config-help
  • yclept make-doc
Next
Yclept Class
Previous
Installation
Copyright © 2023-2025, Cameron F. Abrams
Made with Sphinx and @pradyunsg's Furo
GitHub LinkedIn