Chapter 4. Documentation and Best Practices
So far, the focus was on developing the code and getting the first release out the door. We have not talked about another vital aspect of application development, the documentation and coding standards. Although the code base is still quite manageable, before it is too late, we should learn techniques to improve code readability. In this chapter, we will cover the following topics:
- Understanding the basics of the reStructuredText (RST) format and how to use it for writing docstrings
- Learning how to create HTML documentation for the code using the Sphinx document generator
- Covering some important coding standards for writing the Python code
- Using Pylint to evaluate how well we are doing in following these guidelines
As you can guess from the preceding topics, we are taking a short break from coding to learn these very important concepts.
|
If you are well aware of the code, you might find documentation unnecessary. But imagine you are assigned... |
