From 6ed439c835bd5bee09773957e135cf0b493c56b0 2019-08-14 23:24:49 From: Lance Edgar Date: 2019-08-14 23:24:49 Subject: [PATCH] Add some inter-doc links --- diff --git a/docs/api/rattail/importing/index.rst b/docs/api/rattail/importing/index.rst index 69124bc8d3bb5a8b82a1453de6df40d062b6a32c..4b98d3c27e578203ba7d396efad610fb0ece175d 100644 --- a/docs/api/rattail/importing/index.rst +++ b/docs/api/rattail/importing/index.rst @@ -18,6 +18,9 @@ That way you can reference ``importing.Importer`` as well as ``importing.model.ProductImporter`` etc. The full list of what's available in this ``rattail.importing`` namespace follows. +Please also see :doc:`/narr/importers` for some of the general concepts +involved here. + Importers --------- diff --git a/docs/narr/importers.rst b/docs/narr/importers.rst index 8139befcd9d310675c69744f3254f150e62a78b0..361931df3115411a41359ddc49ebdfd9b1bd0525 100644 --- a/docs/narr/importers.rst +++ b/docs/narr/importers.rst @@ -3,7 +3,7 @@ Data Importers ============== A frequent need when integrating systems is to import (or export, depending on -your perspective) data from one system to another. Rattail provdes a +your perspective) data from one system to another. Rattail provides a framework for this, which offers the following benefits: * "dry run" mode to check things out before committing changes @@ -17,8 +17,7 @@ framework for this, which offers the following benefits: The rest of this document aims to explain the concepts and patterns involved with the Rattail importer framework. -.. todo:: - Add link for code / API docs here. +See also the API docs for :mod:`rattail.importing` (and sub-modules). "Importer" vs. "DataSync" @@ -119,8 +118,13 @@ Note also that to make a new importer, you must have already started a project based on Rattail; this doc will not explain that process. The examples which follow assume this project is named 'myapp'. -.. todo:: - Write docs for starting a new Rattail project / link here. +.. note:: + For now, we do have a wiki doc for `Creating a New Project`_. Note that the + wiki uses the name "Poser" to refer to the custom app, whereas the doc + you're currently reading uses "myapp" for the same purpose. Some day they + both should use "Poser" though... + +.. _Creating a New Project: https://rattailproject.org/moin/NewProject File / Module Structure