Skip to content

docs: fix syntax highlighting for literalincludes of Python code #369

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
robertrueger merged 1 commit into from
Mar 3, 2026
Merged

docs: fix syntax highlighting for literalincludes of Python code #369

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
1 change: 1 addition & 0 deletions doc/source/examples/ADFFrag/ADFFrag.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ It simply redirects the usual |AMSResults| methods to the results of the full sy


.. literalinclude:: ../../../../src/scm/plams/recipes/adffragment.py
:language: python

.. include:: ADFFrag.common_header.rst
.. include:: adffrag.ipynb.rst
Expand Down
3 changes: 2 additions & 1 deletion doc/source/examples/ADFNBO/ADFNBO.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ No specialized |Results| subclass is defined for ``ADFNBOJob``.
The source code of the whole module:

.. literalinclude:: ../../../../src/scm/plams/recipes/adfnbo.py
:language: python

.. include:: ADFNBO.common_header.rst
.. include:: ADFNBO.ipynb.rst
.. include:: ADFNBO.common_footer.rst
.. include:: ADFNBO.common_footer.rst
1 change: 1 addition & 0 deletions doc/source/examples/BandFrag/BandFrag.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ It simply redirects the usual |AMSResults| methods to the results of the full sy
A derived subclass |NOCVBandFragmentJob| is also provided. It can be usefull for generating NOCV plots after the PEDA-NOCV calculation.

.. literalinclude:: ../../../../src/scm/plams/recipes/bandfragment.py
:language: python

.. include:: BandFrag.common_header.rst
.. include:: bandfrag.ipynb.rst
Expand Down
3 changes: 2 additions & 1 deletion doc/source/examples/COSMORSCompound/COSMORSCompound.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@ Source code for ``ADFCOSMORSCompound``
.. dropdown::

.. literalinclude:: ../../../../src/scm/plams/recipes/adfcosmorscompound.py
:language: python

Brief API Documentation
-----------------------

.. automodule:: scm.plams.recipes.adfcosmorscompound
:no-special-members:
:exclude-members: _result_type, __init__, new_children, postrun, _get_radii, adf_settings
:exclude-members: _result_type, __init__, new_children, postrun, _get_radii, adf_settings
3 changes: 2 additions & 1 deletion doc/source/examples/NumGrad/NumGrad.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Any function that takes results of a single point job and returns a single numbe
The source code of the whole module with both abovementioned classes:

.. literalinclude:: ../../../../src/scm/plams/recipes/numgrad.py
:language: python

.. include:: NumGrad.common_header.rst
.. include:: NumGrad.ipynb.rst
.. include:: NumGrad.common_footer.rst
.. include:: NumGrad.common_footer.rst
3 changes: 2 additions & 1 deletion doc/source/examples/NumHess/NumHess.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ The returned Hessian can optionally be mass weighted.
The source code of the whole module with both aforementioned classes:

.. literalinclude:: ../../../../src/scm/plams/recipes/numhess.py
:language: python

.. include:: NumHess.common_header.rst
.. include:: NumHess.ipynb.rst
.. include:: NumHess.common_footer.rst
.. include:: NumHess.common_footer.rst
1 change: 1 addition & 0 deletions doc/source/examples/ReorganizationEnergy/ReorganizationEnergy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ In this recipe we build a job class ``ReorganizationEnergyJob`` by extending |Mu
In ``ReorganizationEnergyResults``, the reorganization energy is computed by fetching and combining the results from the children jobs.

.. literalinclude:: ../../../../src/scm/plams/recipes/reorganization_energy.py
:language: python


.. include:: ReorganizationEnergy.common_header.rst
Expand Down
1 change: 1 addition & 0 deletions doc/source/examples/pyAHFCDOS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ The ``FCFDOS`` class allows one to easily calculate the density of states for an
For an example, see :ref:`Vibronic Density of States with ADF<fcf_dos>`.

.. literalinclude:: ../../../src/scm/plams/recipes/fcf_dos.py
:language: python


Loading