diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 87ec7b1..eb5cb6b 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -30,6 +30,6 @@ sphinx: # Optional but recommended, declare the Python requirements required # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html - python: - install: - - requirements: docs/requirements.txt \ No newline at end of file +python: + install: + - requirements: docs/requirements.txt diff --git a/README.md b/README.md index 71932f6..6235c6d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ ## Documentation -[Documentation](https://sermetpekin.github.io/evdspy-repo/) + +[Documentation](https://evdspy-repo.readthedocs.io/en/latest/) + ## evdspy @@ -25,6 +27,21 @@ api_key will be saved to a file if it was given to get_series function. It will later calls if it was saved before. Alternatively save function can be used. +#### save("MyApiKey"): + + Program will store your api key in your environment in a safe folder + called APIKEY_FOLDER + and only use it when you run a new request which was not requested + recently depending on your cache preference. + +. +```python +from evdspy import save +save("MyApiKey") + +``` + + ```python from evdspy import get_series, default_start_date_fnc, default_end_date_fnc @@ -466,7 +483,7 @@ or modify this file or delete and create a new on from menu or console using com create_options() -![image](https://user-images.githubusercontent.com/96650846/201921534-22ef45f0-85cf-4982-b160-2fe37a21d491.png) + ## OPTION 2 _________________________________ diff --git a/docs/requirements.txt b/docs/requirements.txt index 483a4e9..3b7bf27 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,3 @@ +evdspy sphinx_rtd_theme +sphinx_book_theme diff --git a/docs/source/conf.py b/docs/source/conf.py index 09221fa..03ab272 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -35,8 +35,11 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'sphinx_rtd_theme' -html_static_path = ['_static'] + +# html_theme = 'sphinx_rtd_theme' +html_theme = 'sphinx_book_theme' + +html_static_path = ['static'] # extensions = ['myst_parser'] source_suffix = { '.rst': 'restructuredtext', diff --git a/evdspy/EVDSlocal/index_requests/user_requests.py b/evdspy/EVDSlocal/index_requests/user_requests.py index 2a82d76..a9fedf3 100644 --- a/evdspy/EVDSlocal/index_requests/user_requests.py +++ b/evdspy/EVDSlocal/index_requests/user_requests.py @@ -221,11 +221,8 @@ def domain(self) -> str: def alias(self): return "series=" - +# ....................................................................... UrlDataGroup class UrlDataGroup(UrlSeries): - @property - def domain(self) -> str: - return "https://evds2.tcmb.gov.tr/service/evds" @property def alias(self):