Skip to content

New Documentation Draft#1211

Merged
lkstrp merged 44 commits intov1-docsfrom
new-docs
Jun 11, 2025
Merged

New Documentation Draft#1211
lkstrp merged 44 commits intov1-docsfrom
new-docs

Conversation

@lkstrp lkstrp added this to the v1.0 milestone Apr 14, 2025
@lkstrp lkstrp added the docs Documentation improvements or features to be showcased in docs/ notebook label Apr 14, 2025
@lkstrp lkstrp changed the base branch from master to v1-docs June 11, 2025 08:49
@lkstrp lkstrp changed the title New Documentation New Documentation Draft Jun 11, 2025
@lkstrp lkstrp marked this pull request as ready for review June 11, 2025 08:49
@lkstrp lkstrp merged commit bddda7c into v1-docs Jun 11, 2025
20 checks passed
@lkstrp lkstrp deleted the new-docs branch June 11, 2025 11:35
lkstrp added a commit that referenced this pull request Jun 25, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings
lkstrp added a commit that referenced this pull request Jul 15, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Jul 25, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Aug 4, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Aug 15, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Sep 16, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Sep 23, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Sep 24, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Sep 24, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Sep 25, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Oct 9, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
lkstrp added a commit that referenced this pull request Oct 14, 2025
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation improvements or features to be showcased in docs/ notebook

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants