Skip to content

Commit

Permalink
Docs: Update to links from static doc pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mlange05 committed May 4, 2024
1 parent dd01f94 commit e022c98
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 35 deletions.
4 changes: 2 additions & 2 deletions docs/source/backends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ representation to a string representation in the syntax of the target language.

.. autosummary::

loki.visitors.pprint.Stringifier
loki.visitors.pprint.pprint
loki.ir.pprint.Stringifier
loki.ir.pprint.pprint

Typically, this includes also a custom mapper for expression trees as a
subclass of :any:`LokiStringifyMapper`. For convenience, each of these
Expand Down
11 changes: 6 additions & 5 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,12 @@ provided for this are:
Example transformations and current features
============================================

Loki is primarily an API and toolbox, requiring developers to create their
own head scripts to create and invoke source-to-source translation toolchains.
A small set of transformations considered generic enough are provided by the
package itself in :mod:`loki.transform`. The majority of more complex transformations
are collected in a separate Python package that lives under ``transformations``.
Loki is primarily an API and toolbox, allowing developers to create their
own head scripts and to create and invoke source-to-source translation toolchains.
In addition, a set of supported transformations is provided by the
package itself in :mod:`loki.transformations`. These range from utilities
that can be used with generic Fortran codes to highly bespoke transformations
for generating GPU code based on highly model-specific assumptions.

The ``loki_transform.py`` script is provided by the Loki install. The primary
transformation passes provided by these example transformations are:
Expand Down
1 change: 0 additions & 1 deletion docs/source/internal_representation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,6 @@ Mix-ins

.. autosummary::

loki.expression.symbols.ExprMetadataMixin
loki.expression.symbols.StrCompareMixin

Expression modules
Expand Down
1 change: 0 additions & 1 deletion docs/source/loki_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,4 @@ API reference

loki
scripts
transformations
lint_rules
32 changes: 16 additions & 16 deletions docs/source/transform.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,11 @@ side-effects.
Typically, transformations should be implemented by users to encode the
transformation pipeline for their individual use-case. However, Loki comes
with a growing number of built-in transformations that are implemented in
the :mod:`loki.transform` namespace:
the :mod:`loki.transformations` namespace:

.. autosummary::

loki.transform
loki.transformations

This includes also a number of tools for common transformation tasks that
are provided as functions that can be readily used when implementing new
Expand Down Expand Up @@ -281,17 +281,17 @@ Other traversal modes may be added in the future.

.. autosummary::

loki.bulk.scheduler.Scheduler
loki.bulk.scheduler.SGraph
loki.bulk.scheduler.SFilter
loki.bulk.configure.SchedulerConfig
loki.bulk.configure.TransformationConfig
loki.bulk.configure.ItemConfig
loki.bulk.item.Item
loki.bulk.item.FileItem
loki.bulk.item.ModuleItem
loki.bulk.item.ProcedureItem
loki.bulk.item.TypeDefItem
loki.bulk.item.ProcedureBindingItem
loki.bulk.item.InterfaceItem
loki.bulk.item.ItemFactory
loki.batch.scheduler.Scheduler
loki.batch.scheduler.SGraph
loki.batch.scheduler.SFilter
loki.batch.configure.SchedulerConfig
loki.batch.configure.TransformationConfig
loki.batch.configure.ItemConfig
loki.batch.item.Item
loki.batch.item.FileItem
loki.batch.item.ModuleItem
loki.batch.item.ProcedureItem
loki.batch.item.TypeDefItem
loki.batch.item.ProcedureBindingItem
loki.batch.item.InterfaceItem
loki.batch.item.ItemFactory
20 changes: 10 additions & 10 deletions docs/source/visitors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ for that job with some bespoke variants for specific use cases.

.. autosummary::

loki.visitors.FindNodes
loki.visitors.FindScopes
loki.visitors.SequenceFinder
loki.visitors.PatternFinder
loki.ir.find.FindNodes
loki.ir.find.FindScopes
loki.ir.find.SequenceFinder
loki.ir.find.PatternFinder

A common pattern for using :any:`FindNodes` is the following:

Expand All @@ -71,10 +71,10 @@ nodes according to a mapper.

.. autosummary::

loki.visitors.Transformer
loki.visitors.NestedTransformer
loki.visitors.MaskedTransformer
loki.visitors.NestedMaskedTransformer
loki.ir.transformer.Transformer
loki.ir.transformer.NestedTransformer
loki.ir.transformer.MaskedTransformer
loki.ir.transformer.NestedMaskedTransformer

:any:`Transformer` is commonly used in conjunction with :any:`FindNodes`, with
the latter being used to build the mapper for the first. The following example
Expand Down Expand Up @@ -107,8 +107,8 @@ pretty-printer for the IR that is useful for debugging.

.. autosummary::

loki.visitors.pprint.Stringifier
loki.visitors.pprint
loki.ir.print.Stringifier
loki.ir.print

Implementing new visitors
-------------------------
Expand Down

0 comments on commit e022c98

Please sign in to comment.