Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare template documents for furo style docs #1131

Draft
wants to merge 61 commits into
base: dev
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
61 commits
Select commit Hold shift + click to select a range
a94a054
Prepare template documents for furo style docs
fwitte Nov 8, 2024
85aee13
Check in mini version for header and remove old bg version
fwitte Nov 21, 2024
73c2882
Add compact darkmode version of logo
fwitte Nov 21, 2024
2b98f67
inserted darkmode figures in usage.rst
esske Nov 21, 2024
817f2e4
Add missing darkmode logos
fwitte Nov 21, 2024
debb531
Make MINI logo version permanent darkmode
fwitte Nov 21, 2024
bd933ae
Merge remote-tracking branch 'esske/docs_figure_links' into docs/make…
fwitte Nov 21, 2024
048b4ca
Remove unnecessary tocs
fwitte Nov 21, 2024
dda97f7
Add darkmode of extraction turbine...
maltefritz Nov 22, 2024
83d0a3d
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
maltefritz Nov 22, 2024
bab0aab
Add darkmode version GenericCHP figure.
jfreissmann Nov 22, 2024
cb11d1f
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
jfreissmann Nov 22, 2024
087ed93
Update toc
fwitte Nov 22, 2024
ee20c1f
Rename consistently to oemof.solph
fwitte Nov 22, 2024
cc06774
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
maltefritz Nov 22, 2024
77e175e
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
jfreissmann Nov 22, 2024
e3dcd8e
Add basic conecpt of energy systems file.
jfreissmann Nov 22, 2024
2c071ae
Add basic conecpt of buses file.
jfreissmann Nov 22, 2024
4f7ef57
Add basic conecpt of flows file.
jfreissmann Nov 22, 2024
04b78a6
Add basic conecpt of components file.
jfreissmann Nov 22, 2024
d312cca
Add overview of basic concepts.
jfreissmann Nov 22, 2024
6c544c2
Clean up some old files and update names
fwitte Nov 22, 2024
0025923
Make figure paths absolute
fwitte Nov 22, 2024
52aab71
Add showcase.rst
maltefritz Nov 22, 2024
0a4fd2b
Merge remote-tracking branch 'jfreissmann/docs/make-style-modern' int…
fwitte Nov 22, 2024
a1f180a
Check in missing single file toc elements for new structure
fwitte Nov 22, 2024
381f006
Add darkmode image of extraction turbine.
maltefritz Nov 22, 2024
f2d5c87
Add pages for introductory tutorials
paulapreuss Nov 22, 2024
021f9fb
Add introductory tutorials overview page
paulapreuss Nov 22, 2024
1f1dfa5
Add a support template
fwitte Nov 22, 2024
c11193a
Merge remote-tracking branch 'paula/docs/make-style-modern' into docs…
fwitte Nov 22, 2024
477ad5e
Fix internal reference to building blocks
fwitte Nov 22, 2024
e17605a
Merge remote-tracking branch 'mfritz/docs/make-style-modern' into doc…
fwitte Nov 22, 2024
1ddd75d
Fix typo
fwitte Nov 22, 2024
f3218f0
Add structure for advanced tutorials in docs
pranaykasturi Nov 22, 2024
e2f31ee
Merge remote-tracking branch 'pranay/docs/make-style-modern' into doc…
fwitte Nov 22, 2024
bb03ce3
Add oemof_solph_example_darkmode.svg to docs
srhbrnds Nov 22, 2024
f14e583
Make installation page look nice
fwitte Nov 24, 2024
51cd2d6
Fix typos
fwitte Nov 24, 2024
8fa7a62
Refactor the landing page to make it more compact for faster orientation
fwitte Nov 24, 2024
e470517
Add a boilerplate concept for one of the tutorials
fwitte Nov 25, 2024
0b0f8f9
Remove unused toxenv
fwitte Nov 27, 2024
e961bbe
Make tox pull requirements from extra dependency [dev]
fwitte Nov 27, 2024
bb96a45
Add draft table of contents for district heating example
fwitte Dec 9, 2024
5a4aca4
Finalize drafting structure
fwitte Dec 9, 2024
6fc9764
Add a note, that heat storage capacity will be dimensioned ad-hoc
fwitte Dec 9, 2024
714aa71
Add a couple of example lines to the tutoriakl
fwitte Jan 9, 2025
f09f679
Rename file
fwitte Jan 9, 2025
9a0fc31
Fix links
fwitte Jan 9, 2025
578efeb
Update label
fwitte Jan 9, 2025
6b76d50
Merge dev into docs/make-style-modern
fwitte Jan 14, 2025
f5c2e3f
Merge branch 'dev' into docs/make-style-modern
p-snft Jan 14, 2025
ca3b7f9
Rename directory tutorial to tutorials
p-snft Jan 15, 2025
d9ccfc5
Add tutorials to pyproject.toml
p-snft Jan 15, 2025
2222118
Apply Black code to doc config
p-snft Jan 15, 2025
9506ed1
Apply Black style to tutorial stubs
p-snft Jan 15, 2025
7fa12cc
Re-add deps for [testenv] in tox.ini
p-snft Jan 15, 2025
d34ac97
Draft information for the support page
fwitte Jan 15, 2025
060b719
Add two lines of text to the API landing page
fwitte Jan 15, 2025
715e4c7
Make naming convention for branches consistent
fwitte Jan 16, 2025
95cf0ae
Change the order of locations to get user support
fwitte Jan 16, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ sphinx:
formats: []
python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
extra_requirements:
- dev
18 changes: 11 additions & 7 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _contribute_label:

============
Contributing
============
Expand Down Expand Up @@ -45,23 +47,27 @@ To set up `oemof-solph` for local development:

git clone [email protected]:oemof/oemof-solph.git

3. Create a branch for local development::
3. Install oemof.solph in editable mode with dev dependencies::

pip install -e ./path/to/local/clone[dev]

4. Create a branch for local development::

git checkout -b name-of-your-bugfix-or-feature
`git checkout -b features/name-of-your-feature` or `git checkout -b fix/name-of-your-fix`

Now you can make your changes locally.

4. When you're done making changes run all the checks and docs builder with `tox <https://tox.wiki/en/latest/installation.html>`_ one command::
5. When you're done making changes run all the checks and docs builder with `tox <https://tox.wiki/en/latest/installation.html>`_ one command::

tox

5. Commit your changes and push your branch to GitHub::
6. Commit your changes and push your branch to GitHub::

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

6. Submit a pull request through the GitHub website.
7. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------
Expand All @@ -80,7 +86,6 @@ For merging, you should:

It will be slower though ...


Tests
-----

Expand All @@ -105,7 +110,6 @@ Note, to combine the coverage data from all the tox environments run:

PYTEST_ADDOPTS=--cov-append tox


Tips
----

Expand Down
432 changes: 208 additions & 224 deletions docs/_files/ExtractionTurbine_range_of_operation.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading