- Trending Categories
Data Structure
Networking
RDBMS
Operating System
Java
iOS
HTML
CSS
Android
Python
C Programming
C++
C#
MongoDB
MySQL
Javascript
PHP
- Selected Reading
- UPSC IAS Exams Notes
- Developer's Best Practices
- Questions and Answers
- Effective Resume Writing
- HR Interview Questions
- Computer Glossary
- Who is Who
How to produce documentation for Python functions?
<html><body><p>Information about a function or documentation is put in docstrings in a function. The following are the guidelines to be followed while writing the docstrings.</p><p>The first line should always be a short, concise summary of the object’s purpose. For brevity, it should not explicitly state the object’s name or type. This line should begin with a capital letter and end with a period.</p><p>If there are more lines in the documentation string, the second line should be blank, visually separating the summary from the rest of the description</p><p><strong>Sphinx</strong></p><p>Sphinx is the most popular Python documentation tool. It converts reStructuredText markup language into a range of output formats including HTML, LaTeX (for printable PDF versions), manual pages, and plain text.</p><p>When run, Sphinx will import your code and using Python’s introspection features it will extract all function, method and class signatures. It will also extract the accompanying docstrings, and compile it all into well-structured and easily readable documentation for your project.</p></body></html>
Updated on 30-Jul-2019 22:30:20
- Related Questions & Answers
- How can we call the documentation for NumPy and SciPy?
- How to produce a barcode in Matplotlib?
- How to produce your content hard to copy
- How to Generate API Documentation in Postman?
- How to produce group subtotals for all combinations of the dimensions specified in Oracle?
- Java documentation comments
- Python Functions creating iterators for efficient looping
- How to get JShell documentation in Java 9?
- Documentation generation using the pydoc module in Python
- Java API documentation generator
- Generating MySQL Doxygen Documentation Content
- Test Documentation in Software Testing
- Testing Documentation in Software Testing
- Using operations to produce desired results in JavaScript
- How to produce group subtotals and a grand total in Oracle?
Advertisements