Wheel

Table of Contents

  • This document is a literate program
  • Why literate programming
  • Source Code and Support
  • A minimal implementation using YAML
  • Literate programming is generative programming
  • Setup
  • Code Walkthrough with Example
  • Early Attempts
  • How to port existing code ?
  • Use cases
  • Guidelines
  • Limitations and Security
  • Next Steps
  • Bookmarks
Xyzzy Apps Home

(c) Xyzzy Apps, 2021

Welcome to Wheel’s documentation!¶

Table of Contents

  • This document is a literate program
    • Intro
    • Screencast
    • Project Genesis
    • Example
  • Why literate programming
    • What does literate programming offer ?
    • Criss Cross Programming
    • Personal Observations
  • Source Code and Support
  • A minimal implementation using YAML
  • Literate programming is generative programming
  • Setup
    • Python and Sphinx Setup
    • Sphinx Config
  • Code Walkthrough with Example
    • How does cog work ?
    • wheel.sh
    • Simple Example (Extend this)
      • Main
      • Test
      • Fizz Buzz
    • Execute Code
    • Read docs
  • Early Attempts
  • How to port existing code ?
  • Use cases
    • Dev Ops
    • Students / Data Scientists
    • Standards
    • Linux Users
    • Bloggers / Writers
    • Designer / Startup / Game Developer
    • Programmers / Open Source developers
  • Guidelines
    • What can you put into the documentation ?
    • Misc Notes on Writing
    • Drafts
  • Limitations and Security
  • Next Steps
  • Bookmarks
    • Books written in Literate Programming
      • Computer Science
      • Historical Books
    • Misc Bookmarks
    • More preprocessors
This document is a literate program

By Xyzzy Apps
© Copyright (c) Xyzzy Apps, 2021.