diff --git a/.cruft.json b/.cruft.json index 6cbcad7c..0f52c9b6 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "https://github.com/Ouranosinc/cookiecutter-pypackage", - "commit": "e528361615f8bb4b886206b9cd49ffda76c45b45", + "commit": "de751c55cd9a5df586e3d961535292cfb73e0397", "checkout": null, "context": { "cookiecutter": { diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e7e56240..eecc4b12 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -63,7 +63,7 @@ Ready to contribute? Here's how to set up ``figanos`` for local development for $ mamba env create -f environment-dev.yml $ conda activate figanos - $ flit install --symlink . + $ flit install --symlink #. To ensure a consistent style, please install the pre-commit hooks to your repo:: diff --git a/Makefile b/Makefile index ab04253e..756536b3 100644 --- a/Makefile +++ b/Makefile @@ -98,7 +98,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 diff --git a/docs/installation.rst b/docs/installation.rst index 0994af05..8de7b42e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -28,12 +28,14 @@ Then you can create the environment and install the package: .. code-block:: console $ cd figanos - $ conda env create -f environment.yml + $ conda env create -f environment-dev.yml -Finally, perform an `--editable` install of figanos: +Finally, perform an `--symlink` install of figanos: .. code-block:: console - $ python -m pip install . + $ flit install --symlink + # Or + $ make dev .. _Github repo: https://github.com/Ouranosinc/figanos diff --git a/environment-dev.yml b/environment-dev.yml index c50765ba..220a2e6e 100644 --- a/environment-dev.yml +++ b/environment-dev.yml @@ -48,7 +48,6 @@ dependencies: - sphinx >=6.2.0 - sphinx-autoapi - sphinx-book-theme >=1.0.0 - - sphinx-click - sphinx-codeautolink - sphinx-copybutton - sphinxcontrib-napoleon diff --git a/pyproject.toml b/pyproject.toml index 4e980cff..405fdb69 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -79,7 +79,6 @@ docs = [ "ipython", "jupyter_client", "nbsphinx", - "sphinx-click", "sphinx-codeautolink", "sphinx-copybutton", "sphinx>=6.2.0", @@ -87,9 +86,6 @@ docs = [ "sphinxcontrib-napoleon" ] -[project.scripts] -figanos = "figanos.cli:cli" - [project.urls] "Homepage" = "https://figanos.readthedocs.io/" "Changelog" = "https://figanos.readthedocs.io/en/stable/changes.html" @@ -143,26 +139,26 @@ include = [ "CHANGES.rst", "CONTRIBUTING.rst", "LICENSE", + "Makefile", "README.rst", - "docs/**/*.gif", - "docs/**/*.jpg", - "docs/**/*.png", - "docs/**/*.rst", + "docs/*.rst", "docs/Makefile", + "docs/_static/_images/*.gif", + "docs/_static/_images/*.jpg", + "docs/_static/_images/*.png", + "docs/_static/_images/*.rst", "docs/conf.py", "docs/make.bat", - "setup.cfg", + "docs/notebooks/.ipynb", + "environment-docs.yml", + "environment-dev.yml", "tests/*.py", - "figanos/**/*.json", - "figanos/**/*.mplstyle", - "figanos/**/*.png", - "figanos/**/*.py", - "figanos/**/*.txt", - "figanos/**/*.yml" + "figanos", + "tox.ini" ] exclude = [ - "**/*.py[co]", - "**/__pycache__", + "*.py[co]", + "__pycache__", ".coveralls.yml", ".editorconfig", ".flake8", @@ -170,12 +166,8 @@ exclude = [ ".pre-commit-config.yaml", ".readthedocs.yml", ".yamllint.yaml", - "Makefile", "docs/modules.rst", - "docs/figanos*.rst", - "environment-docs.yml", - "environment-dev.yml", - "tox.ini" + "docs/figanos*.rst" ] [tool.isort]