diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8d8754cd..1ae170d1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -150,7 +150,7 @@ Creating a development environment Before starting any development, you'll need to create an isolated xCDAT development environment: -- We recommend installing `Anaconda`_ or `Miniconda`_ +- We recommend installing `Anaconda`_ or `Miniforge3`_ - Make sure your conda is up to date (``conda update conda``) - Make sure that you have forked and cloned the `repository`_. If you are in the xCDAT organization, forking is not needed since you will have direct read access to the repository @@ -192,9 +192,8 @@ To return to your root environment: See the full `conda docs here`_. -.. _Miniforge: https://github.com/conda-forge/miniforge .. _Anaconda: https://www.anaconda.com/download -.. _Miniconda: https://docs.conda.io/projects/miniconda/en/latest/ +.. _Miniforge3: https://github.com/conda-forge/miniforge .. _repository: https://github.com/xCDAT/xcdat .. _conda docs here: http://conda.pydata.org/docs diff --git a/Makefile b/Makefile index 68e1e7d4..da3392c3 100644 --- a/Makefile +++ b/Makefile @@ -31,7 +31,7 @@ help: # Clean local repository # ---------------------- -clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts +clean: clean-build clean-docs clean-pyc clean-test ## remove all build, docs, test, coverage and Python artifacts clean-build: ## remove build artifacts rm -fr build/ @@ -55,6 +55,10 @@ clean-test: ## remove test and coverage artifacts rm -fr .pytest_cache rm -rf .mypy_cache +clean-docs: + rm -rf docs/_build + rm -rf docs/generated + # Quality Assurance # ---------------------- pre-commit: # run pre-commit quality assurance checks @@ -74,6 +78,7 @@ test: ## run tests quickly with the default Python and produces code coverage re # Documentation # ---------------------- docs: ## generate Sphinx HTML documentation, including API docs + rm -rf docs/_build rm -rf docs/generated cd docs && make html $(MAKE) -C docs clean diff --git a/conda-env/ci.yml b/conda-env/ci.yml index 017428c3..b475f487 100644 --- a/conda-env/ci.yml +++ b/conda-env/ci.yml @@ -24,4 +24,3 @@ dependencies: # ================== - pytest - pytest-cov -prefix: /opt/miniconda3/envs/xcdat_ci diff --git a/conda-env/dev.yml b/conda-env/dev.yml index fad006ab..b95c3001 100644 --- a/conda-env/dev.yml +++ b/conda-env/dev.yml @@ -47,4 +47,3 @@ dependencies: # ================== - jupyterlab - tbump -prefix: /opt/miniconda3/envs/xcdat_dev diff --git a/docs/getting-started-guide/getting-started-hpc-jupyter.rst b/docs/getting-started-guide/getting-started-hpc-jupyter.rst index c7bfc0b8..34d7c6a0 100644 --- a/docs/getting-started-guide/getting-started-hpc-jupyter.rst +++ b/docs/getting-started-guide/getting-started-hpc-jupyter.rst @@ -20,10 +20,10 @@ Ensure ``conda`` is installed ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Generally, the installation instructions from the `Installation <../installation.rst>`_ -page can also be followed for HPC machines. This guide covers installing Miniconda3 and +page can also be followed for HPC machines. This guide covers installing Miniforge3 and creating a conda environment with the ``xcdat`` package. -Before installing Miniconda3, you should consult your HPC documentation to see if +Before installing Miniforge3, you should consult your HPC documentation to see if ``conda`` is already available; in some cases, ``python`` and ``conda`` may be pre-installed on an HPC machine. You can check to see whether they are available by entering ``which conda`` and/or ``which python`` in the command line (which will