Skip to content

Commit

Permalink
Table of contents for config page (#248)
Browse files Browse the repository at this point in the history
* table of contents for config page

Add a table of contents for config page in the documentation.

* remove header title

Co-authored-by: Doris Lee <dorisjunglinlee@gmail.com>
  • Loading branch information
anupambaranwal and dorisjlee committed Feb 1, 2021
1 parent bff1c60 commit 5cfd44c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/source/reference/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Configuration Settings

In Lux, users can customize various global settings to configure the behavior of Lux through :py:class:`lux.config.Config`. These configurations are applied across all dataframes in the session. This page documents some of the configurations that you can apply in Lux.

.. contents:: :local:

.. note::

Lux caches past generated recommendations, so if you have already printed the dataframe in the past, the recommendations would not be regenerated with the new config properties. In order for the config properties to apply, you would need to explicitly expire the recommendations as such:
Expand All @@ -26,6 +28,7 @@ In Lux, users can customize various global settings to configure the behavior of
df # recommendations generated for the first time with config
Change the default display
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 5cfd44c

Please sign in to comment.