diff options
author | halcy <halcy@ARARAGI-KUN> | 2022-11-19 00:28:25 +0200 |
---|---|---|
committer | halcy <halcy@ARARAGI-KUN> | 2022-11-19 00:28:25 +0200 |
commit | 8d6177c07eae5a61fede1ef78ba20b9a74ddb312 (patch) | |
tree | a8c56229dbcaf237e0984562e6bf1264816284b0 /docs | |
parent | 31a00f07c19bf057bca0834f541eae581cd80a0c (diff) | |
download | mastodon.py-8d6177c07eae5a61fede1ef78ba20b9a74ddb312.tar.gz |
Document "rules" attribute, make docs maybe a bit better
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 5 | ||||
-rw-r--r-- | docs/index.rst | 3 |
2 files changed, 6 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index c6fc0fb..6198b9b 100644 --- a/docs/conf.py +++ b/docs/conf.py | |||
@@ -134,7 +134,10 @@ todo_include_todos = False | |||
134 | # further. For a list of options available for each theme, see the | 134 | # further. For a list of options available for each theme, see the |
135 | # documentation. | 135 | # documentation. |
136 | # | 136 | # |
137 | # html_theme_options = {} | 137 | html_theme_options = { |
138 | "collapse_navigation": False, | ||
139 | "navigation_depth": -1 | ||
140 | } | ||
138 | 141 | ||
139 | # Add any paths that contain custom themes here, relative to this directory. | 142 | # Add any paths that contain custom themes here, relative to this directory. |
140 | # html_theme_path = [] | 143 | # html_theme_path = [] |
diff --git a/docs/index.rst b/docs/index.rst index 7c4f200..1351b1a 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -687,7 +687,8 @@ Instance dicts | |||
687 | # has chosen to advertise. | 687 | # has chosen to advertise. |
688 | 'registrations': # Boolean indication whether registrations on this instance are open | 688 | 'registrations': # Boolean indication whether registrations on this instance are open |
689 | # (True) or not (False) | 689 | # (True) or not (False) |
690 | 'approval_required': # True if account approval is required when registering | 690 | 'approval_required': # True if account approval is required when registering, |
691 | 'rules': # List of dicts with `id` and `text` fields, one for each server rule set by the admin | ||
691 | } | 692 | } |
692 | 693 | ||
693 | Activity dicts | 694 | Activity dicts |