A New Way Of Coding¶
I have been looking for a way of coding and documentation for a long time. This is my current coding flow.
- Write some code and get it working.
- Write a Markdown document about the code and use include tags in that document to include the code in the document.
Where I am going¶
- In the past I made a script to convert Python code into Markdown, including Markdown formatted comments in the code. I may dig this out or rewrite it to make the source code more like a literate program.
- Make sure that all these coding programs are checked into Git.
- Make the process of generating the documentation more automatic.
- Make an index to the code.
- Make sure the actual source documentation and extensions is also included and checked in.
Hello world! fromon_page_markdown.py