Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
martin-schlipf committed Feb 2, 2024
1 parent bb1d085 commit b5a4597
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/_templates/package.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

.. automodule:: {{ fullname }}

Attributes
----------
.. rubric:: Attributes

.. autosummary::
:toctree:
:template: member.rst
Expand Down
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,17 +145,17 @@ how you can apply *py4vasp* in your research.

.. currentmodule:: py4vasp

Packages
--------
.. rubric:: Packages

.. autosummary::
:toctree: _packages
:template: package.rst
:recursive:

calculation

Classes
-------
.. rubric:: Classes

.. autosummary::
:toctree: _classes
:template: class.rst
Expand Down
6 changes: 2 additions & 4 deletions src/py4vasp/calculation/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,12 @@ class provides a more flexible interface with which you can determine the source
of the modules as methods of attributes, i.e., the two following examples are
equivalent:
using :mod:`~py4vasp.calculation` module
""""""""""""""""""""""""""""""""""""""""
.. rubric:: using :mod:`~py4vasp.calculation` module
>>> from py4vasp import calculation
>>> calculation.dos.read()
using :class:`~py4vasp.Calculation` class
"""""""""""""""""""""""""""""""""""""""""
.. rubric:: using :class:`~py4vasp.Calculation` class
>>> from py4vasp import Calculation
>>> calc = Calculation.from_path(".")
Expand Down

0 comments on commit b5a4597

Please sign in to comment.