@@ -25,9 +25,11 @@ The name of your project.
2525
2626Must start with a lowercase letter, followed by one or more of the following (a-z, 0-9, _, -).
2727
28- If you distribute your code via PyPI, this is the name that will be used. This will allow users to install like so: `` pip install < project_name> ``.
28+ This will be used to connect to your project on github, as in `` https://github.com/{{project_organization}}/{{ project_name}} ``.
2929
30- Note that this will be used to connect to your project on github, as in ``https://github.com/{{project_organization}}/{{project_name}} ``.
30+ If you distribute your code via PyPI, this is the name that will be used. This will allow users to install like so: ``pip install <project_name> ``.
31+
32+ Read more at :doc: `../practices/pypi `.
3133
3234
33353. Python package name
@@ -214,6 +216,8 @@ If this option is selected, the template will create an example module and test
214216 | Options | **✱ yes **, no |
215217 +------------+------------------------------------------------------------------------+
216218
219+ See :doc: `../practices/sphinx `.
220+
217221If this option is selected, any docstrings in your Python files will be turned into API documentation via Sphinx autodoc.
218222
219223The template will create directories and configuration files to enable Sphinx document generation and ReadTheDocs integration::
@@ -229,7 +233,6 @@ The template will create directories and configuration files to enable Sphinx do
229233 ├─ ...
230234
231235
232-
23323614. Rendered notebooks
234237----------------------
235238
@@ -266,3 +269,5 @@ It will also create a sample benchmarking suite under ``benchmarks/``::
266269 │ ├─ benchmarks/
267270 │ │ ├─ benchmarks.py
268271 ├─ ...
272+
273+ Read more at :doc: `../practices/ci_benchmarking `.
0 commit comments