Re: [myhdl-list] Another typo in docs
Brought to you by:
jandecaluwe
From: Christopher F. <chr...@gm...> - 2014-05-23 19:57:41
|
> > Would it make sense to convert the code snippets in the Sphinx > documentation to doctests so this can be picked up automatically? I can > have a bash at this if desired (certainly, the FSM one above would be > useful as a doctest). Yes, I think this is a great idea, I actually have a start on this. I have a couple sections completed with doctest. If others agree I can create a PR with my changes and then you can add to if you like :) > Also (and separately), is there a reason why the API docs aren't > autogenerated with Sphinx autodoc (with the content in the Python > docstrings)? > Don't know if there is a reason for this? Regards, Chris |