Skip to content

update toc for DFT functionalities #3

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

Merged
g-bauer merged 1 commit into from
Nov 23, 2021
Merged

update toc for DFT functionalities #3

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
13 changes: 10 additions & 3 deletions docs/api/fmt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Functional
FMTVersion
State

External potential, pores and adsorption
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Adsorption
~~~~~~~~~~

.. autosummary::
:toctree: generated/
Expand All @@ -26,6 +26,13 @@ External potential, pores and adsorption
Geometry
Pore1D
Pore3D
PairCorrelation
Adsorption1D
Adsorption3D

Solvation
~~~~~~~~~

.. autosummary::
:toctree: generated/

PairCorrelation
1 change: 0 additions & 1 deletion docs/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Implementations of equations of state and possibly classical density functional
user_defined
peng_robinson
pcsaft
gc_pcsaft

Density functional theory
-------------------------
Expand Down
25 changes: 21 additions & 4 deletions docs/api/pcsaft.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,17 @@ Density functional theory
PhaseDiagramBinary
PhaseDiagramHetero

External potential, pores and adsorption
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Interfaces
^^^^^^^^^^

.. autosummary::
:toctree: generated/

PlanarInterface
SurfaceTensionDiagram

Adsorption
^^^^^^^^^^

.. autosummary::
:toctree: generated/
Expand All @@ -66,6 +75,14 @@ External potential, pores and adsorption
Geometry
Pore1D
Pore3D
PairCorrelation
Adsorption1D
Adsorption3D
Adsorption3D

Solvation
^^^^^^^^^

.. autosummary::
:toctree: generated/

PairCorrelation
SolvationProfile