From 53a4352fc6e0c0968ccecc4085591c99cfbd6831 Mon Sep 17 00:00:00 2001 From: Tianning Li Date: Tue, 18 Jun 2024 18:07:58 +0800 Subject: [PATCH] Fix doc --- .readthedocs.yaml | 13 +++++++ docs/Makefile | 6 +-- docs/{ => source}/calendar.rst | 0 docs/{ => source}/conf.py | 0 docs/{ => source}/crypto.rst | 0 docs/{ => source}/earnings.rst | 0 docs/{ => source}/forex.rst | 0 docs/{ => source}/future.rst | 0 docs/{ => source}/group.rst | 0 docs/{ => source}/index.rst | 0 docs/{ => source}/insider.rst | 0 docs/source/news.rst | 10 +++++ docs/source/quote.rst | 10 +++++ docs/source/screener.rst | 54 +++++++++++++++++++++++++++ finvizfinance/group/base.py | 4 +- finvizfinance/quote.py | 2 +- finvizfinance/screener/base.py | 4 +- finvizfinance/screener/custom.py | 2 +- finvizfinance/screener/financial.py | 2 +- finvizfinance/screener/overview.py | 2 +- finvizfinance/screener/ownership.py | 2 +- finvizfinance/screener/performance.py | 2 +- finvizfinance/screener/technical.py | 2 +- finvizfinance/screener/ticker.py | 2 +- finvizfinance/screener/valuation.py | 2 +- 25 files changed, 103 insertions(+), 16 deletions(-) create mode 100644 .readthedocs.yaml rename docs/{ => source}/calendar.rst (100%) rename docs/{ => source}/conf.py (100%) rename docs/{ => source}/crypto.rst (100%) rename docs/{ => source}/earnings.rst (100%) rename docs/{ => source}/forex.rst (100%) rename docs/{ => source}/future.rst (100%) rename docs/{ => source}/group.rst (100%) rename docs/{ => source}/index.rst (100%) rename docs/{ => source}/insider.rst (100%) create mode 100644 docs/source/news.rst create mode 100644 docs/source/quote.rst create mode 100644 docs/source/screener.rst diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..416f465 --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile index d4bb2cb..269cadc 100644 --- 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) \ No newline at end of file diff --git a/docs/calendar.rst b/docs/source/calendar.rst similarity index 100% rename from docs/calendar.rst rename to docs/source/calendar.rst diff --git a/docs/conf.py b/docs/source/conf.py similarity index 100% rename from docs/conf.py rename to docs/source/conf.py diff --git a/docs/crypto.rst b/docs/source/crypto.rst similarity index 100% rename from docs/crypto.rst rename to docs/source/crypto.rst diff --git a/docs/earnings.rst b/docs/source/earnings.rst similarity index 100% rename from docs/earnings.rst rename to docs/source/earnings.rst diff --git a/docs/forex.rst b/docs/source/forex.rst similarity index 100% rename from docs/forex.rst rename to docs/source/forex.rst diff --git a/docs/future.rst b/docs/source/future.rst similarity index 100% rename from docs/future.rst rename to docs/source/future.rst diff --git a/docs/group.rst b/docs/source/group.rst similarity index 100% rename from docs/group.rst rename to docs/source/group.rst diff --git a/docs/index.rst b/docs/source/index.rst similarity index 100% rename from docs/index.rst rename to docs/source/index.rst diff --git a/docs/insider.rst b/docs/source/insider.rst similarity index 100% rename from docs/insider.rst rename to docs/source/insider.rst diff --git a/docs/source/news.rst b/docs/source/news.rst new file mode 100644 index 0000000..16b029f --- /dev/null +++ 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 new file mode 100644 index 0000000..1213391 --- /dev/null +++ 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 new file mode 100644 index 0000000..09f37d1 --- /dev/null +++ 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 index 27a6655..6b826a2 100644 --- 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 """ diff --git a/finvizfinance/quote.py b/finvizfinance/quote.py index 185c635..9a72f0b 100644 --- a/finvizfinance/quote.py +++ b/finvizfinance/quote.py @@ -1,5 +1,5 @@ """ -.. module:: finvizfinance +.. module:: quote :synopsis: individual ticker. .. moduleauthor:: Tianning Li diff --git a/finvizfinance/screener/base.py b/finvizfinance/screener/base.py index f948aa1..3895dfd 100644 --- 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 diff --git a/finvizfinance/screener/custom.py b/finvizfinance/screener/custom.py index 028c70a..5ee31c1 100644 --- 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 diff --git a/finvizfinance/screener/financial.py b/finvizfinance/screener/financial.py index 11a0e8e..65f952f 100644 --- 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 diff --git a/finvizfinance/screener/overview.py b/finvizfinance/screener/overview.py index d21e912..6dbd8ec 100644 --- 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 diff --git a/finvizfinance/screener/ownership.py b/finvizfinance/screener/ownership.py index 675e1d9..26696eb 100644 --- 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 diff --git a/finvizfinance/screener/performance.py b/finvizfinance/screener/performance.py index d1bf095..71a0cd2 100644 --- 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 diff --git a/finvizfinance/screener/technical.py b/finvizfinance/screener/technical.py index 2c9aab2..3407ee6 100644 --- 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 diff --git a/finvizfinance/screener/ticker.py b/finvizfinance/screener/ticker.py index 20db118..b2e8077 100644 --- 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 diff --git a/finvizfinance/screener/valuation.py b/finvizfinance/screener/valuation.py index 3855f78..04947ae 100644 --- 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