Creating Python Function docstrings and Running doctests
What information goes into a Python function docstring? How can you create tests within your docstrings, that can be checked with doctests?
This is a portion of a full course on creating documentation for your projects using MkDocs and mkdocstrings.
The complete course can be found here:
https://realpython.com/courses/building-project-documentation-mkdocs/
The full course also includes how to:
- Work with MkDocs to produce static pages from Markdown
- Pull in code documentation from docstrings using mkdocstrings
- Use the Material for MkDocs theme to make your documentation look good
- Host your documentation on GitHub Page
Видео Creating Python Function docstrings and Running doctests канала Real Python
This is a portion of a full course on creating documentation for your projects using MkDocs and mkdocstrings.
The complete course can be found here:
https://realpython.com/courses/building-project-documentation-mkdocs/
The full course also includes how to:
- Work with MkDocs to produce static pages from Markdown
- Pull in code documentation from docstrings using mkdocstrings
- Use the Material for MkDocs theme to make your documentation look good
- Host your documentation on GitHub Page
Видео Creating Python Function docstrings and Running doctests канала Real Python
Показать
Комментарии отсутствуют
Информация о видео
Другие видео канала
![Discussing Mojo & Improving Python Object-Oriented Programming | Real Python Podcast #157](https://i.ytimg.com/vi/mt4LCmQ9A7Q/default.jpg)
![Real Python Community Members: Bob Frederick](https://i.ytimg.com/vi/91JfnfjUZ3o/default.jpg)
![Orchestrating Large and Small Projects With Apache Airflow | Real Python Podcast #142](https://i.ytimg.com/vi/FjPHuqlnR_k/default.jpg)
![Speeding Up Your DataFrames With Polars | Real Python Podcast #140](https://i.ytimg.com/vi/vLYCKWFeC3k/default.jpg)
![Introduction to Integers and Floating Point Numbers: Python Basics](https://i.ytimg.com/vi/Nc1BhYKs56Y/default.jpg)
![Building Python CI With Docker & Applying for a Hacker Initiative Grant | Real Python Podcast #158](https://i.ytimg.com/vi/DReWGl1uqMA/default.jpg)
![Exploring Python With bpython & Formalizing f-String Grammar | Real Python Podcast #141](https://i.ytimg.com/vi/2kaPDVD1Qr8/default.jpg)
![Evaluating Python Packages & Celebrating 20 Years of PyCon US | Real Python Podcast #151](https://i.ytimg.com/vi/UWzizzIxavg/default.jpg)
![Identifying a Substring Within a Python String](https://i.ytimg.com/vi/GYj9QTGALjY/default.jpg)
![Real Python Community Members: Paul Paradis](https://i.ytimg.com/vi/_OilVwwQWdI/default.jpg)
![Real Python Community Members: Alex Elder](https://i.ytimg.com/vi/_0mmwqqtsVw/default.jpg)
![Automate Processes and Distribute Python Tools With RPA and RCC | Real Python Podcast #152](https://i.ytimg.com/vi/wgQ1PZxgE1Q/default.jpg)
![Start Testing Your Python with doctest & Pagination in Django | Real Python Podcast #109](https://i.ytimg.com/vi/3h8xehjFvgw/default.jpg)
![Ready to Publish Your Python Packages? | Real Python Podcast #83](https://i.ytimg.com/vi/SghTaQuMBxE/default.jpg)
![Starting With REST APIs and Django Ninja](https://i.ytimg.com/vi/W9d_vXGpxs0/default.jpg)
![Supporting Python Open Source Projects and Maintainers | Real Python Podcast #73](https://i.ytimg.com/vi/ijR1mqJNXX8/default.jpg)
![Data Version Control in Python and Real Python Video Transcripts | Real Python Podcast #25](https://i.ytimg.com/vi/a3NL30-WeAk/default.jpg)
![Starting With YAML and PyYAML in Python](https://i.ytimg.com/vi/AfD79cc2Kzg/default.jpg)
![Improve Matplotlib With Style Sheets & Python Async for the Web | Real Python Podcast #125](https://i.ytimg.com/vi/hn0QIaWYo-w/default.jpg)
![Real Python Community Members: Edward Wright](https://i.ytimg.com/vi/zOjRKfj5nXY/default.jpg)