Triggered by this recent tweet advertising a new pytest plugin that can document itself, I want to briefly describe how you can get sphinx-autodoc to recognize and document the tests.
It is slightly more work since you have to tell Sphinx to auto-document each
individual module manually. At least, I haven't yet spent the time to os.walk
the test directory and document each one. Assuming the following project
| alias j="cd (cat ~/Library/autojump/autojump.txt | sort -nr | awk '{print \$2}' | fzf +s)" |
This is some red text.
| import os | |
| from subprocess import check_call | |
| def post_save(model, os_path, contents_manager): | |
| """post-save hook for converting notebooks to .py and .html files.""" | |
| if model['type'] != 'notebook': | |
| return # only do this for notebooks | |
| d, fname = os.path.split(os_path) | |
| check_call(['jupyter', 'nbconvert', '--to', 'script', fname], cwd=d) | |
| check_call(['jupyter', 'nbconvert', '--to', 'html', fname], cwd=d) |
| bind-key C-b send-prefix | |
| bind-key C-o rotate-window | |
| bind-key C-q confirm-before kill-server | |
| bind-key C-z suspend-client | |
| bind-key Space next-layout | |
| bind-key ! break-pane | |
| bind-key # list-buffers | |
| bind-key $ command-prompt -I #S "rename-session '%%'" | |
| bind-key & confirm-before -p "kill-window #W? (y/n)" kill-window | |
| # Commennt out caused by Gist syntax error |
| from IPython.display import display, HTML | |
| display(HTML(data=""" | |
| <style> | |
| div#notebook-container { width: 95%; } | |
| div#menubar-container { width: 65%; } | |
| div#maintoolbar-container { width: 99%; } | |
| </style> | |
| """)) |
| # https://gist.github.com/codexico/2a34c0d599f3af93b46f | |
| [color] | |
| # Use colors in Git commands that are capable of colored output when | |
| # outputting to the terminal. (This is the default setting in Git ≥ 1.8.4.) | |
| ui = auto | |
| [color "branch"] |
git add HISTORY.md
git commit -m "Changelog for upcoming release 0.1.1."
bumpversion patch