diff --git a/docs/source/backends.rst b/docs/source/backends.rst index 8d9b27ab8..f3819f82a 100644 --- a/docs/source/backends.rst +++ b/docs/source/backends.rst @@ -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 diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 6c16528ea..f95012620 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -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: diff --git a/docs/source/internal_representation.rst b/docs/source/internal_representation.rst index 4bf94bd9b..3e2536e91 100644 --- a/docs/source/internal_representation.rst +++ b/docs/source/internal_representation.rst @@ -259,7 +259,6 @@ Mix-ins .. autosummary:: - loki.expression.symbols.ExprMetadataMixin loki.expression.symbols.StrCompareMixin Expression modules diff --git a/docs/source/loki_api.rst b/docs/source/loki_api.rst index 06cd6877e..ee60897c5 100644 --- a/docs/source/loki_api.rst +++ b/docs/source/loki_api.rst @@ -8,5 +8,4 @@ API reference loki scripts - transformations lint_rules diff --git a/docs/source/transform.rst b/docs/source/transform.rst index feacd57ef..b9941acf4 100644 --- a/docs/source/transform.rst +++ b/docs/source/transform.rst @@ -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 diff --git a/docs/source/visitors.rst b/docs/source/visitors.rst index bf16aa08b..d72253425 100644 --- a/docs/source/visitors.rst +++ b/docs/source/visitors.rst @@ -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.visitors.FindNodes + loki.ir.visitors.FindScopes + loki.ir.visitors.SequenceFinder + loki.ir.visitors.PatternFinder A common pattern for using :any:`FindNodes` is the following: