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.

Sign up for GitHub

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

Jump to bottom

Refactor Concepts into its own top section. #661

Merged
merged 1 commit into from
Dec 5, 2022
Merged

Refactor Concepts into its own top section. #661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
0 docs/source/user_guide/concepts.rst → docs/source/concepts/concepts.rst
View file
Open in desktop
File renamed without changes.
14 changes: 12 additions & 2 deletions docs/source/user_guide/dpf_concepts.rst → docs/source/concepts/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
.. _dpf_concepts:
.. _ref_concepts:

========
Concepts
========

This section gives in depth descriptions and explanations of DPF concepts, including terminology.

Other sections of this guide include :ref:`ref_user_guide`, :ref:`ref_api_section`,
:ref:`ref_dpf_operators_reference`, and :ref:`gallery`.


DPF concepts
~~~~~~~~~~~~
Expand All @@ -10,7 +20,7 @@ DPF concepts
waysofusing.rst
stepbystep.rst


.. card-carousel:: 2

.. card:: Concepts and terminology
Expand Down
0 docs/source/user_guide/stepbystep.rst → docs/source/concepts/stepbystep.rst
View file
Open in desktop
File renamed without changes.
0 docs/source/user_guide/waysofusing.rst → docs/source/concepts/waysofusing.rst
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ of the framework. Because DPF is plugin-based, new features or formats can be ea

getting_started/index
user_guide/index
concepts/index
api/index
operator_reference
examples/index
Expand Down
8 changes: 2 additions & 6 deletions docs/source/user_guide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,11 @@ computation, customization, and remote postprocessing accessible in Python.

This section has the following goals:

- Describe basic DPF concepts, including terminology.
- Describe the most-used DPF entities and how they can help you to access and modify solver data.
- Provide simple how-tos for tackling most common use cases.

Other sections of this guide include :ref:`ref_api_section`, :ref:`ref_dpf_operators_reference`,
and :ref:`gallery`.

.. include::
dpf_concepts.rst
Other sections of this guide include :ref:`ref_concepts`, :ref:`ref_api_section`,
:ref:`ref_dpf_operators_reference`, and :ref:`gallery`.

.. include::
main_entities.rst
Expand Down