Skip to content

Commit

Permalink
ci(rtd): cleanup obsolete environment and requirement files
Browse files Browse the repository at this point in the history
  • Loading branch information
kmnhan committed Jul 15, 2024
1 parent b5d8aa4 commit 37d93bc
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 73 deletions.
4 changes: 0 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ version: 2
build:
os: ubuntu-22.04
tools:
# python: "mambaforge-22.9"
python: "3.11"

# Build documentation in the "docs/" directory with Sphinx
Expand All @@ -26,6 +25,3 @@ formats:
python:
install:
- requirements: docs/requirements.txt

# conda:
# environment: docs/environment.yml
41 changes: 0 additions & 41 deletions docs/environment.yml

This file was deleted.

1 change: 0 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
dask>=2024.4.1
pyqt6>=6.2.2
ipykernel
-e '.[viz,perf,misc,docs]'
18 changes: 11 additions & 7 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ reflected in the package without having to reinstall it. Before installing:
mamba activate <envname>
2. Install the repository.
2. Build and install the package.

.. note::

Expand All @@ -138,6 +138,16 @@ reflected in the package without having to reinstall it. Before installing:
pip install -e ".[dev]" --config-settings editable_mode=compat
These two steps will create the new environment, and not touch any of your existing
environments, nor any existing Python installation.

To view your environments::bash

mamba env list

To return to your root environment::bash

mamba deactivate

Updating the editable installation
----------------------------------
Expand Down Expand Up @@ -368,12 +378,6 @@ Check whether all documentation dependencies are installed with
pip install -r docs/requirements.txt
or

.. code-block:: sh
mamba env update -f docs/environment.yml -n <envname>
then build the documentation by running:

.. code-block:: sh
Expand Down
19 changes: 0 additions & 19 deletions requirements.txt

This file was deleted.

3 changes: 2 additions & 1 deletion templates/CHANGELOG.md.j2
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# CHANGELOG
# Changelog
This project tries to follow [Semantic Versioning](https://semver.org/).
{% import ".macros.j2" as macros -%}
{% if context.history.unreleased | length > 0 %}
{# UNRELEASED #}
Expand Down

0 comments on commit 37d93bc

Please sign in to comment.