Merge pull request #109 from lit26/fix/doc

Fix doc
lit26 · Jun 18, 2024 · 3989a10 · 3989a10
2 parents 32934f8 + 53a4352
commit 3989a10
Show file tree

Hide file tree

Showing 25 changed files with 103 additions and 16 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: "2"
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: requirements-doc.txt
+
+sphinx:
+  configuration: docs/source/conf.py
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/calendar.rst → docs/source/calendar.rst b/docs/calendar.rst → docs/source/calendar.rst
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
diff --git a/docs/crypto.rst → docs/source/crypto.rst b/docs/crypto.rst → docs/source/crypto.rst
diff --git a/docs/earnings.rst → docs/source/earnings.rst b/docs/earnings.rst → docs/source/earnings.rst
diff --git a/docs/forex.rst → docs/source/forex.rst b/docs/forex.rst → docs/source/forex.rst
diff --git a/docs/future.rst → docs/source/future.rst b/docs/future.rst → docs/source/future.rst
diff --git a/docs/group.rst → docs/source/group.rst b/docs/group.rst → docs/source/group.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
diff --git a/docs/insider.rst → docs/source/insider.rst b/docs/insider.rst → docs/source/insider.rst
diff --git a/docs/source/news.rst b/docs/source/news.rst
@@ -0,0 +1,10 @@
+News
+**************************
+
+Getting news.
+
+.. automodule:: finvizfinance.news
+   :members:
+
+
+
diff --git a/docs/source/quote.rst b/docs/source/quote.rst
@@ -0,0 +1,10 @@
+Quote
+**************************
+
+Getting stock information.
+
+.. automodule:: finvizfinance.quote
+   :members:
+
+
+
diff --git a/docs/source/screener.rst b/docs/source/screener.rst
@@ -0,0 +1,54 @@
+Screener
+**************************
+
+Getting screener information.
+
+Overview
+=============
+
+.. automodule:: finvizfinance.screener.overview
+   :show-inheritance:
+   :inherited-members:
+
+Valuation
+=============
+
+.. automodule:: finvizfinance.screener.valuation
+   :show-inheritance:
+   :inherited-members:
+
+Financial
+=============
+
+.. automodule:: finvizfinance.screener.financial
+   :show-inheritance:
+   :inherited-members:
+
+Ownership
+=============
+
+.. automodule:: finvizfinance.screener.ownership
+   :show-inheritance:
+   :inherited-members:
+
+Performance
+=============
+
+.. automodule:: finvizfinance.screener.performance
+   :show-inheritance:
+   :inherited-members:
+
+Technical
+=============
+
+.. automodule:: finvizfinance.screener.technical
+   :show-inheritance:
+   :inherited-members:
+
+Ticker
+=============
+
+.. automodule:: finvizfinance.screener.ticker
+   :show-inheritance:
+   :inherited-members:
+
diff --git a/finvizfinance/group/base.py b/finvizfinance/group/base.py
@@ -1,6 +1,6 @@
 """
-.. module:: group.overview
-   :synopsis: group overview table.
+.. module:: group.base
+   :synopsis: group base module.
 
 .. moduleauthor:: Tianning Li <[email protected]>
 """

diff --git a/finvizfinance/quote.py b/finvizfinance/quote.py
@@ -1,5 +1,5 @@
 """
-.. module:: finvizfinance
+.. module:: quote
    :synopsis: individual ticker.
 
 .. moduleauthor:: Tianning Li <[email protected]>

diff --git a/finvizfinance/screener/base.py b/finvizfinance/screener/base.py
@@ -1,6 +1,6 @@
 """
-.. module:: screen.overview
-   :synopsis: screen overview table.
+.. module:: screener.base
+   :synopsis: screen base module.
 
 .. moduleauthor:: Tianning Li <[email protected]>
 

diff --git a/finvizfinance/screener/custom.py b/finvizfinance/screener/custom.py
@@ -1,5 +1,5 @@
 """
-.. module:: screen.custom
+.. module:: screener.custom
    :synopsis: screen custom table.
 
 .. moduleauthor:: Tianning Li <[email protected]>

diff --git a/finvizfinance/screener/financial.py b/finvizfinance/screener/financial.py
@@ -1,5 +1,5 @@
 """
-.. module:: screen.financial
+.. module:: screener.financial
    :synopsis: screen financial table.
 
 .. moduleauthor:: Tianning Li <[email protected]>

diff --git a/finvizfinance/screener/overview.py b/finvizfinance/screener/overview.py
@@ -1,5 +1,5 @@
 """
-.. module:: screen.overview
+.. module:: screener.overview
    :synopsis: screen overview table.
 
 .. moduleauthor:: Tianning Li <[email protected]>

diff --git a/finvizfinance/screener/ownership.py b/finvizfinance/screener/ownership.py
@@ -1,5 +1,5 @@
 """
-.. module:: screen.ownership
+.. module:: screener.ownership
    :synopsis: screen ownership table.
 
 .. moduleauthor:: Tianning Li <[email protected]>

diff --git a/finvizfinance/screener/performance.py b/finvizfinance/screener/performance.py
@@ -1,5 +1,5 @@
 """
-.. module:: screen.performance
+.. module:: screener.performance
    :synopsis: screen performance table.
 
 .. moduleauthor:: Tianning Li <[email protected]>

diff --git a/finvizfinance/screener/technical.py b/finvizfinance/screener/technical.py
@@ -1,5 +1,5 @@
 """
-.. module:: screen.technical
+.. module:: screener.technical
    :synopsis: screen technical table.
 
 .. moduleauthor:: Tianning Li <[email protected]>

diff --git a/finvizfinance/screener/ticker.py b/finvizfinance/screener/ticker.py
@@ -1,5 +1,5 @@
 """
-.. module:: screen.ticker
+.. module:: screener.ticker
    :synopsis: screen ticker table.
 
 .. moduleauthor:: Tianning Li <[email protected]>

diff --git a/finvizfinance/screener/valuation.py b/finvizfinance/screener/valuation.py
@@ -1,5 +1,5 @@
 """
-.. module:: screen.valuation
+.. module:: screener.valuation
    :synopsis: screen valuation table.
 
 .. moduleauthor:: Tianning Li <[email protected]>