make docs

quillcraftsman · Sep 7, 2024 · 69c0244 · 69c0244
1 parent cc59895
commit 69c0244
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -79,7 +79,7 @@ You can find **Full Project Documentation** [here][documentation_path]
 
 `tenda-everest` is python package to manage Tenda Everest router.
 This package was tested on **EVEREST EWR-F303** Wireless Router with **Tenda** firmware **V02.03.01.125** 
-(and similar). But this package may be can work on different routers with other firmwares.
+(and similar). But this package may work on different routers with other firmwares.
 
 ![Everest ewr-f303 router picture](https://github.com/quillcraftsman/tenda-everest/blob/main/everest.jpeg)
 

diff --git a/docs/about.rst b/docs/about.rst
@@ -16,7 +16,7 @@ Mission
 
 **tenda-everest** is python package to manage Tenda Everest router.
 This package was tested on **EVEREST EWR-F303** Wireless Router with **Tenda** firmware **V02.03.01.125**
-(and similar). But this package may be can work on different routers with other firmwares.
+(and similar). But this package may work on different routers with other firmwares.
 
 Open Source Project
 -------------------

diff --git a/docs/package/modules.rst b/docs/package/modules.rst
@@ -0,0 +1,7 @@
+tenda_everest
+=============
+
+.. toctree::
+   :maxdepth: 4
+
+   tenda_everest
diff --git a/docs/package/tenda_everest.rst b/docs/package/tenda_everest.rst
@@ -0,0 +1,29 @@
+tenda\_everest package
+======================
+
+Submodules
+----------
+
+tenda\_everest.main module
+--------------------------
+
+.. automodule:: tenda_everest.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tenda\_everest.package module
+-----------------------------
+
+.. automodule:: tenda_everest.package
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tenda_everest
+   :members:
+   :undoc-members:
+   :show-inheritance: