goerz / cookiecutter-pypackage Goto Github PK

Can we use numpy style docstrings ?
For example https://github.com/numpy/numpydoc/blob/master/doc/example.py

If not, can we configure this cookiecutter or modify it in some way to use numpy style docstrings.

doctr is a better alternative to ReadTheDocs

In Sphinx docs, version should be the version number and release should be the version + git revision for dev-versions, or the same as version otherwise.

https://github.com/sympy/sphinx-math-dollar

tox should be mandatory, and make optional

Shouldn't this line

pip install cookiecutter

be changed to

pip install tox cookiecutter

The Makefile should contain a command to generate coverage data locally

See https://gist.github.com/ramnathv/2227408

See https://github.com/agronholm/sphinx-autodoc-typehints

This package would have to be added to the requirements and set up in conf.py

https://pre-commit.com

qucontrol/krotov@3106167

If sphinx-doc/sphinx#6768 is merged, we'll no longer have to use better-apidoc.

On running this command

tox -e run-cmd -- doctr configure --no-upload-key --no-authenticate --key-path docs/doctr_deploy_key

for configuring doctr. I have the following result.
ERROR: venv 'run-cmd' in /home/tejas/git-tejas/cookiedust/csw would delete project ERROR: ConfigError: envdir must not equal toxinidir

See goerz/docs_versions_menu#13