Git Product home page Git Product logo

auto-tutorial's Introduction

Automatic Generated tutorial documentation

This is a tryout for auto generated tutorial documentation directly from the code files. For now this only works for python.

Tutorial in MD with direct code snippets

Run this to try the snippet parser out:

python snippet_parser.py source_code\test_code_snippets.md

Here first the markdown file build up and then the /snippet command takes out code snippets from the given python script. The result is given in /test_code_snippet_gen.md

Full tutorial from one python file

Run this in a terminal test out an example script.

python tutorial_parser.py source_code/test_tutorial.py

This generates /generated/test_tutorial.md which is a markdown file with the code snippets within. It also generates /generated/test_tutorial_only_code.py, which is a python script with only code and none of the text.

auto-tutorial's People

Contributors

knmcguire avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.