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

Contribution to refactoring of the Docs #1134

Merged
490 changes: 490 additions & 0 deletions docs/_files/GenericCHP_darkmode.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 65 additions & 0 deletions docs/basic_concepts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
.. _basic_concepts_label:

~~~~~~~~~~~~~~
Basic Concepts
~~~~~~~~~~~~~~

The following sections give a detailed overview on the basic concepts of
oemof.solph. This includes all important components like the energy system,
buses and flows as well as the basic components.

.. toctree::
:maxdepth: 1
:glob:
:hidden:

basic_concepts/energy_system.rst
basic_concepts/buses.rst
basic_concepts/flows.rst
basic_concepts/components.rst

.. grid:: 2
:gutter: 1

.. grid-item-card:: Energy System
:link: basic_concepts_energy_system_label
:link-type: ref

.. image:: /_static/_logo/logo_oemof_solph_NOTEXT.svg
:class: only-light

.. image:: /_static/_logo/logo_oemof_solph_NOTEXT_darkmode.svg
:class: only-dark

.. grid-item-card:: Buses
:link: basic_concepts_buses_label
:link-type: ref

.. image:: /_static/_logo/logo_oemof_solph_NOTEXT.svg
:class: only-light

.. image:: /_static/_logo/logo_oemof_solph_NOTEXT_darkmode.svg
:class: only-dark

.. grid:: 2
:gutter: 1

.. grid-item-card:: Flows
:link: basic_concepts_flows_label
:link-type: ref

.. image:: /_static/_logo/logo_oemof_solph_NOTEXT.svg
:class: only-light

.. image:: /_static/_logo/logo_oemof_solph_NOTEXT_darkmode.svg
:class: only-dark

.. grid-item-card:: Components
:link: basic_concepts_components_label
:link-type: ref

.. image:: /_static/_logo/logo_oemof_solph_NOTEXT.svg
:class: only-light

.. image:: /_static/_logo/logo_oemof_solph_NOTEXT_darkmode.svg
:class: only-dark
7 changes: 7 additions & 0 deletions docs/basic_concepts/buses.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _basic_concepts_buses_label:

~~~~~
Buses
~~~~~

Here could a nice and short explanation of oemof.solphs buses.
8 changes: 8 additions & 0 deletions docs/basic_concepts/components.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _basic_concepts_components_label:

~~~~~~~~~~
Components
~~~~~~~~~~

Here could a nice and short explanation of oemof.solphs components like sinks
and sources as well as converters and storages.
7 changes: 7 additions & 0 deletions docs/basic_concepts/energy_system.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _basic_concepts_energy_system_label:

~~~~~~~~~~~~~
Energy System
~~~~~~~~~~~~~

Here could a nice and short explanation of oemof.solphs energy systems.
7 changes: 7 additions & 0 deletions docs/basic_concepts/flows.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _basic_concepts_flows_label:

~~~~~
Flows
~~~~~

Here could a nice and short explanation of oemof.solphs flows.
Loading