Remove todo page and testing page in documentation
This commit is contained in:
@@ -42,7 +42,6 @@ needs_sphinx = "2.0"
|
||||
extensions = [
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.intersphinx",
|
||||
"sphinx.ext.todo",
|
||||
"sphinx.ext.viewcode",
|
||||
"sphinx.ext.napoleon",
|
||||
"sphinxcontrib.spelling",
|
||||
@@ -172,13 +171,6 @@ autodoc_default_options = {"members": True}
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
intersphinx_mapping = {"https://docs.python.org/": None}
|
||||
|
||||
# -- Options for todo extension ----------------------------------------------
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = True
|
||||
|
||||
todo_link_only = True
|
||||
|
||||
# -- Options for napoleon extension ----------------------------------------------
|
||||
|
||||
# Use Google style docstrings
|
||||
|
@@ -18,7 +18,5 @@ Documentation Overview
|
||||
|
||||
intro
|
||||
examples
|
||||
testing
|
||||
api/index
|
||||
todo
|
||||
faq
|
||||
api/index
|
||||
|
@@ -1,25 +0,0 @@
|
||||
.. _testing:
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
To use the tests, copy ``tests/data.json`` to ``tests/my_data.json`` or type the information manually in the terminal prompts.
|
||||
|
||||
- email: Your (or a test user's) email / phone number
|
||||
- password: Your (or a test user's) password
|
||||
- group_thread_id: A test group that will be used to test group functionality
|
||||
- user_thread_id: A person that will be used to test kick/add functionality (This user should be in the group)
|
||||
|
||||
Please remember to test all supported python versions.
|
||||
If you've made any changes to the 2FA functionality, test it with a 2FA enabled account.
|
||||
|
||||
If you only want to execute specific tests, pass the function names in the command line (not including the ``test_`` prefix). Example:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ python tests.py sendMessage sessions sendEmoji
|
||||
|
||||
.. warning::
|
||||
|
||||
Do not execute the full set of tests in too quick succession. This can get your account temporarily blocked for spam!
|
||||
(You should execute the script at max about 10 times a day)
|
@@ -1,22 +0,0 @@
|
||||
.. _todo:
|
||||
|
||||
Todo
|
||||
====
|
||||
|
||||
This page will be periodically updated to show missing features and documentation
|
||||
|
||||
|
||||
Missing Functionality
|
||||
---------------------
|
||||
|
||||
- Implement ``Client.search_for_message``
|
||||
- This will use the GraphQL request API
|
||||
- Implement chatting with pages properly
|
||||
- Write better FAQ
|
||||
- Explain usage of GraphQL
|
||||
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
.. todolist::
|
Reference in New Issue
Block a user