search

GuyHoozdis / hypermodern-python

A template based on "The Hypermodern Python Project"
MIT License
0 stars 0 forks source link

Chapter 5/docstrings #7

Closed GuyHoozdis closed 1 month ago

GuyHoozdis commented 1 month ago

Why Are We Doing This?

This is the fifth chapter of the Hypermodern Python Project series of articles which covers, mainly, type documentation.

Test Plan

  1. nox - run the default quality checks.
  2. nox -s xdoctests - run the doctests
  3. Generate documentation
    • nox -s docs
    • open docs/_build/index.html
    • Click the link to the license file
    • Click the link to the reference section of the documentation.