AstroPhot
AstroPhot copied to clipboard
Convert docstrings to google format
describe the content in question
All AutoProf methods require docstrings, these should be formatted in google notation. This notation is easily readable in text format as well, making it useful for help strings at the interpreter level as well.
example use case
Example google notation docs can be seen here: https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html
brief outline of updated documentation
This only applies to docstrings
Ultimately joopyter book has struggled with every docs format, so I am using markdown now and manually building notebooks with the docs. This is closed by #267