Merge branch 'main' into contributing-fixes

docs/console_script_setup.rst

@@ -17,7 +17,8 @@ To use the console script in development:
 
 .. code-block:: bash
 
-    python -m flit install --symlink projectdir
+    cd projectdir
+    flit install --symlink
 
 'projectdir' should be the top level project directory with the `pyproject.toml` file
 
@@ -38,7 +39,8 @@ will not necessarily create an editable install. This is a known issue with `fli
 
 .. code-block:: bash
 
-    python -m flit install --symlink projectdir
+    cd projectdir
+    flit install --symlink
 
 More Details
 ------------

docs/pypi_release_checklist.rst

@@ -32,7 +32,7 @@ For Every Release
 
     .. code-block:: bash
 
-        python -m flit install --symlink .
+        flit install --symlink
 
 #. Run the tests:
 

{{cookiecutter.project_slug}}/CONTRIBUTING.rst

@@ -84,15 +84,15 @@ Ready to contribute? Here's how to set up ``{{ cookiecutter.project_slug }}`` fo
 
     $ conda env create -f environment-dev.yml
     $ conda activate {{ cookiecutter.project_slug }}
-    $ flit install --symlink .
+    $ flit install --symlink
   {%- else -%}
 
   Using ``virtualenv`` (``virtualenvwrapper``), you can create a new development environment with::
 
     $ python -m pip install flit virtualenvwrapper
     $ mkvirtualenv {{ cookiecutter.project_slug }}
     $ cd {{ cookiecutter.project_slug }}/
-    $ flit install --symlink .
+    $ flit install --symlink
   {%- endif %}
 
 #. To ensure a consistent style, please install the ``pre-commit`` hooks to your repo::

{{cookiecutter.project_slug}}/Makefile

@@ -114,7 +114,7 @@ release: dist ## package and upload a release
 	python -m flit publish dist/*
 
 install: clean ## install the package to the active Python's site-packages
-	python -m flit install .
+	python -m flit install
 
 dev: clean ## install the package to the active Python's site-packages
-	python -m flit install --symlink .
+	python -m flit install --symlink

{{cookiecutter.project_slug}}/pyproject.toml

@@ -158,23 +158,26 @@ include = [
   {%- endif %}
   "Makefile",
   "README.rst",
+  {%- if cookiecutter.use_conda == 'y' %}
+  "environment-dev.yml",
+  {%- endif %}
   {%- if cookiecutter.make_docs == 'y' %}
-  "docs/**/*.gif",
-  "docs/**/*.jpg",
-  "docs/**/*.png",
-  "docs/**/*.rst",
+  "environment-docs.yml",
+  "docs/_static/_images/*.gif",
+  "docs/_static/_images/*.jpg",
+  "docs/_static/_images/*.png",
+  "docs/_static/_images/*.rst",
   "docs/Makefile",
   "docs/conf.py",
   "docs/make.bat",
   {%- endif %}
-  "setup.cfg",
   "tests/*.py",
   "tox.ini",
-  "{{ cookiecutter.project_slug }}/**/*.py"
+  "{{ cookiecutter.project_slug }}"
 ]
 exclude = [
-  "**/*.py[co]",
-  "**/__pycache__",
+  "*.py[co]",
+  "__pycache__",
   ".coveralls.yml",
   ".editorconfig",
   ".flake8",
@@ -183,15 +186,13 @@ exclude = [
   {%- if cookiecutter.make_docs == 'y' %}
   ".readthedocs.yml",
   {% endif -%}
-  ".yamllint.yaml",
-  "Makefile",
-  {%- if cookiecutter.make_docs == 'y' %}
+  ".yamllint.yaml"
+  {%- if cookiecutter.make_docs == 'y' -%}
+  ,
   "docs/_*",
-  "docs/modules.rst",
-  "docs/{{ cookiecutter.project_slug }}*.rst",
-  "environment-docs.yml",
-  {% endif -%}
-  "environment-dev.yml"
+  "docs/apidoc/modules.rst",
+  "docs/apidoc/{{ cookiecutter.project_slug }}*.rst"
+  {%- endif %}
 ]
 {%- if cookiecutter.use_black == 'y' %}