Documentation and Coding

This week I got an opportunity to write some documentation for my project. Usually, markdown is used to write docs but this time I used sphinx to write man pages.

Initially, I wasn’t able to figure out the use of sphinx(even though its so easy!) since there are few tutorials available on the internet. Writing documentation in sphinx is just like writing code. Need to take care of all the indentations! I also learned the concept of man pages and how helpful they are.

My second task was to read cli arguments from an rc file. This was an interesting feature. I learned a lot of things from this issue about developing CLI applications. Python’s configparser was the saviour here. I also hacked a not so good solution in the beginning, discarded it and started from scratch. Thanks to my mentors for answering all my silly questions patiently.

All my patches can be found here

Thanks for reading!