Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edan-bainglass committed Dec 24, 2024
1 parent 70715e9 commit a23ad8f
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/source/development/guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,23 @@ Developers have two options when using the ``InAppGuide`` widget:
A decent amount of ``InAppGuide(identifier=<identifier>)`` instances have been placed strategically throughout the app.
Developers may suggest additional core guide sections via GitHub pull requests.
For plugin developers, additional instances of either flavor are recommended to be added in any component of the plugin in conjunction with dedicated plugin-specific guides.

Plugin guides
-------------

Plugin developers may introduce additional guides to the app. To do so, add the following key/value entry in your plugin's ``__init__.py`` file:

.. code:: python
my_plugin = {
...
"guides": <path-to-guide>,
}
where ``path-to-guide`` is the path (``Path`` object or absolute string path) to the directory containing the guide HTML files.
On app start, the guide manager will scan the plugin entry points for the ``guides`` key and load the guides accordingly.

Guide order
-----------

When naming your guide HTML documents, prefix the file name with ``#_``. The number ``#`` will determine the order in which the guides are displayed in the list.

0 comments on commit a23ad8f

Please sign in to comment.