docs: add User to the documentation

hearot · Jun 23, 2020 · 2539f70 · 2539f70
1 parent 9e7c1e6
commit 2539f70
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,9 @@
 
 ### Documentation
 
+   - Add `User` to the documentation
    - Add a features list ([e0155add9888f3efc6b2113701f512265c54b4ac](https://github.com/hearot/pyrubrum/commit/e0155add9888f3efc6b2113701f512265c54b4ac))
-   - Add docstrings to `User`
+   - Add docstrings to `User` ([9e7c1e6cb545fafef724eeebb3fc8589aa6eca7c](https://github.com/hearot/pyrubrum/commit/9e7c1e6cb545fafef724eeebb3fc8589aa6eca7c))
 
 ### Fixes
 

diff --git a/FEATURES.md b/FEATURES.md
@@ -1,7 +1,8 @@
 ### Documentation
 
+   - Add `User` to the documentation
    - Add a features list ([e0155add9888f3efc6b2113701f512265c54b4ac](https://github.com/hearot/pyrubrum/commit/e0155add9888f3efc6b2113701f512265c54b4ac))
-   - Add docstrings to `User`
+   - Add docstrings to `User` ([9e7c1e6cb545fafef724eeebb3fc8589aa6eca7c](https://github.com/hearot/pyrubrum/commit/9e7c1e6cb545fafef724eeebb3fc8589aa6eca7c))
 
 ### Fixes
 

diff --git a/docs/source/api/objects/index.rst b/docs/source/api/objects/index.rst
@@ -0,0 +1,7 @@
+Objects
+=======
+
+.. toctree::
+    :caption: Defined objects
+
+    user
diff --git a/docs/source/api/objects/user.rst b/docs/source/api/objects/user.rst
@@ -0,0 +1,5 @@
+User
+====
+
+.. autoclass:: pyrubrum.User
+    :members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -90,7 +90,10 @@
     pass
 
 
-for example in filter(lambda f: f.endswith(".py"), listdir("../../examples")):
+for example in filter(
+    lambda f: f.endswith(".py") and not f.endswith("_private.py"),
+    listdir("../../examples"),
+):
     copyfile("../../examples/" + example, "_static/examples/" + example)
 
     with open(

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -73,6 +73,7 @@ Welcome to Pyrubrum
     api/handlers/index
     api/keyboard/index
     api/menus/index
+    api/objects/index
     api/styles/index
     api/tree/index
     api/types/index

diff --git a/docs_updater.py b/docs_updater.py
@@ -38,6 +38,7 @@
 {tree}
 """
 KEYBOARD_ENTITIES = ["Button", "Element", "Keyboard"]
+OBJECT_ENTITIES = ["User"]
 TEMPLATE = """{title}
 {separators}
 
@@ -103,6 +104,8 @@ def get_file_name(s: str) -> str:
         directory = "keyboard"
     elif entity in TREE_ENTITIES:
         directory = "tree"
+    elif entity in OBJECT_ENTITIES:
+        directory = "objects"
     else:
         directory = "types"