Skip to content

Commit 58c7a0e

Browse files
lkstrplkstrp
committed
various further changes and clean up
1 parent 0535689 commit 58c7a0e

32 files changed

+805
-1040
lines changed

‎.github/workflows/test.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ jobs:
116116
with:
117117
token: ${{ secrets.CODECOV_TOKEN }}
118118

119-
chek-docs:
119+
check-docs:
120120
name: Check docs
121121
needs: [build]
122122
runs-on: ubuntu-latest

‎.gitignore‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
11

22
*~
3-
3+
.~*
44
*.py[cod]
5-
65
.ipynb_checkpoints/
7-
86
*.log
9-
107
old/
118

12-
# Ignore all jupyter notebooks, except the example notebooks
9+
# Ignore all jupyter notebooks, except those for the docs
1310
*.ipynb
1411
!/docs/**/*.ipynb
1512

1613

1714
test/.cache/
18-
1915
.cache/
2016

21-
.~*
22-
2317
test/results/*
2418

2519
pypsa.egg-info/

‎.readthedocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ build:
1414
create_environment:
1515
- uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
1616
install:
17-
- UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs
17+
- UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --all-extras
1818

1919
mkdocs:
2020
configuration: mkdocs.yml

‎docs/api/components/common.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
::: pypsa.components.common
2-
options:
3-
heading_level: 2
1+
::: pypsa.components.common

‎docs/api/components/components.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
::: pypsa.components.Components
2-
options:
3-
heading_level: 2
4-
members_order: source
5-
inherited_members: true
6-
filters:
7-
- "!^_[^_]"
8-
- "!logger"
9-
- "!iteration"
10-
- "!__deepcopy__"
11-
- "!__getitem__"
12-
- "!__setitem__"
13-
- "!add"
14-
- "!get_bounds_pu"
2+
options:
3+
heading_level: 2
4+
members_order: source
5+
inherited_members: true
6+
filters:
7+
- "!^_[^_]"
8+
- "!logger"
9+
- "!iteration"
10+
- "!__deepcopy__"
11+
- "!__getitem__"
12+
- "!__setitem__"
13+
- "!add"
14+
- "!get_bounds_pu"
1515

1616
::: pypsa.components.components.ComponentsData
17-
options:
18-
heading_level: 2
17+
options:
18+
heading_level: 2
1919

‎docs/api/networks/network.md‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,4 @@
44
filters:
55
- "!^_[^_]"
66
- "!logger"
7-
- "!iteration"
8-
# Components
9-
# - "!^(buses|carrier|generators|global_constraints|line_types|lines|links|loads|shapes|shunt_impedances|sub_networks|stores|storage_units|transformers|transformer_types)"
10-
# - "!(_components)$"
11-
# - "!^(components|c|df|static|pnl|dynamic)"
12-
# Descriptors
13-
# - "!^get_(extendable|non_extendable|committable)_i$|^get_(active_assets|switchable_as_(dense|iter))$|^bus_carrier_unit$"
7+
- "!iteration"

‎docs/api/networks/plot.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
options:
33
heading_level: 2
44
members_order: source
5+
56
::: pypsa.plot.statistics.plotter.StatisticPlotter
67
options:
78
heading_level: 2
89
members_order: source
10+
911
::: pypsa.plot.statistics.plotter.StatisticInteractivePlotter
1012
options:
1113
heading_level: 2

‎docs/api/networks/statistics.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
11

22
::: pypsa.statistics.StatisticsAccessor
3+
options:
4+
heading_level: 2
5+
6+
::: pypsa.statistics.grouping.Groupers
7+
options:
8+
heading_level: 2
9+
10+
::: pypsa.optimization.expressions.StatisticExpressionsAccessor
11+
options:
12+
heading_level: 2

‎docs/api/other/api-examples.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Examples
2-
31
::: pypsa.examples
42
options:
53
members_order: source

‎docs/contributing/contributing.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ with new ideas, suggestions, submitting bug reports or contributing code changes
3030
7. Run tests: `pytest` (see [Testing](#testing))
3131
8. Push your changes to your fork and create a pull request on GitHub
3232

33-
TODO: What to work on, TODO, which issues, labeling etc.
33+
<!-- TODO: What to work on, TODO, which issues, labeling etc. -->
3434

3535
### Style
3636

@@ -91,8 +91,9 @@ This will format all the files in the repository and immediately apply the chang
9191
them. It is basically [the same](https://docs.astral.sh/ruff/faq/#how-does-ruffs-formatter-compare-to-black)
9292
as Black.
9393

94-
> **Note**: It is not mandatory to use either Ruff or pre-commit. We will also be running it in
95-
> our CI/CD pipeline. But it's highly recommended, to make everyone's life easier.
94+
!!! note
95+
96+
It is not mandatory to use either Ruff or pre-commit. We will also be running it in our CI/CD pipeline. But it's highly recommended, to make everyone's life easier.
9697

9798
### Testing
9899

0 commit comments

Comments
 (0)