Skip to content

Conversation

tleonhardt
Copy link
Member

This PR fixes several things related to our MkDocs API documentation for cmd2 source code, namely:

  1. Tell mkdocstrings to use the sphinx docstring style so that parameters are properly displayed in a nice tabluar format - this is the large fix in this PR
  2. Properly document exceptions raised in Sphinx style so they also show up correctly in the docs
  3. Fix a couple param names so the docstring matches the signature

@tleonhardt tleonhardt merged commit c51ed84 into master Jan 25, 2025
47 checks passed
@tleonhardt tleonhardt deleted the mkdoc_improvements branch January 25, 2025 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants