From ea1ba6715d6fe5b5dff94451550832de700284e7 Mon Sep 17 00:00:00 2001 From: sdabhi23 Date: Tue, 5 Sep 2023 14:45:50 +0530 Subject: [PATCH 1/6] update test config --- .github/workflows/dev-tests.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/dev-tests.yml b/.github/workflows/dev-tests.yml index 0b21052..6d016f8 100644 --- a/.github/workflows/dev-tests.yml +++ b/.github/workflows/dev-tests.yml @@ -33,5 +33,6 @@ jobs: - name: Upload to codecov uses: codecov/codecov-action@v3 with: + token: ${{ secrets.CODECOV_TOKEN }} files: ./coverage.xml fail_ci_if_error: true From 36e5e1056a909a7f4fd77ac966318224497463c9 Mon Sep 17 00:00:00 2001 From: sdabhi23 Date: Tue, 5 Sep 2023 14:46:11 +0530 Subject: [PATCH 2/6] update docs --- README.md | 9 +++++---- docs/conf.py | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dd52bc0..6c39f70 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,12 @@ Python library for extracting real-time data from Bombay Stock Exchange (India). | Tests on `master` branch | Tests on `dev` branch | Code coverage | Documentation | | ----------------------------------------- | ----------------------------------- | --------------------------------------------- | ------------------------------------- | -| [![tests master][testsmaster]][testslink] | [![tests dev][testsdev]][testslink] | [![code coverage][codecovbadge]][codecovlink] | [![documentation][docbadge]][doclink] | +| [![tests master][testsmaster]][testsmasterlink] | [![tests dev][testsdev]][testsdevlink] | [![code coverage][codecovbadge]][codecovlink] | [![documentation][docbadge]][doclink] | -[testsmaster]: https://github.com/sdabhi23/bsedata/actions/workflows/tests.yml/badge.svg?branch=master -[testsdev]: https://github.com/sdabhi23/bsedata/actions/workflows/tests.yml/badge.svg?branch=dev -[testslink]: https://github.com/sdabhi23/bsedata/actions/workflows/tests.yml +[testsmaster]: https://github.com/sdabhi23/bsedata/actions/workflows/dev-tests.yml/badge.svg?branch=master +[testsdev]: https://github.com/sdabhi23/bsedata/actions/workflows/dev-tests.yml/badge.svg?branch=dev +[testsmasterlink]: https://github.com/sdabhi23/bsedata/actions/workflows/dev-tests.yml?query=branch%3Amaster +[testsdevlink]: https://github.com/sdabhi23/bsedata/actions/workflows/dev-tests.yml?query=branch%3Adev [codecovbadge]: https://codecov.io/gh/sdabhi23/bsedata/branch/master/graph/badge.svg?token=QI8ZPA6ODL [codecovlink]: https://codecov.io/gh/sdabhi23/bsedata [docbadge]: https://readthedocs.org/projects/bsedata/badge/?version=latest diff --git a/docs/conf.py b/docs/conf.py index f80357e..f15aac4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,7 +22,7 @@ author = 'Shrey Dabhi' # The full version, including alpha/beta/rc tags -release = '0.5.3' +release = '0.5.4' # -- General configuration --------------------------------------------------- From 5d5c66d75abd142fd3e3bb385875d30b353a809d Mon Sep 17 00:00:00 2001 From: sdabhi23 Date: Tue, 5 Sep 2023 14:46:23 +0530 Subject: [PATCH 3/6] add read the docs config --- .readthedocs.yml | 33 +++++++++++++++++++++++++++++++++ docs-requires.txt | 7 +++++++ 2 files changed, 40 insertions(+) create mode 100644 .readthedocs.yml create mode 100644 docs-requires.txt diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..04b2322 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,33 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# 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-requires.txt \ No newline at end of file diff --git a/docs-requires.txt b/docs-requires.txt new file mode 100644 index 0000000..96d2fb3 --- /dev/null +++ b/docs-requires.txt @@ -0,0 +1,7 @@ +sphinxext-opengraph +sphinx-copybutton +beautifulsoup4 +requests +sphinx +furo +lxml From d905b9821354ce21be4be13f10696cc01459e37a Mon Sep 17 00:00:00 2001 From: sdabhi23 Date: Tue, 5 Sep 2023 15:21:25 +0530 Subject: [PATCH 4/6] try #1 to fix docs build --- .readthedocs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 04b2322..042e914 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -28,6 +28,6 @@ formats: all # 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-requires.txt \ No newline at end of file +# python: +# install: +# - requirements: docs-requires.txt \ No newline at end of file From 513dabd8e37a71391ea51913cd57565561fde2ba Mon Sep 17 00:00:00 2001 From: sdabhi23 Date: Tue, 5 Sep 2023 15:30:18 +0530 Subject: [PATCH 5/6] fix docs --- .readthedocs.yml | 6 +++--- docs/conf.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 042e914..04b2322 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -28,6 +28,6 @@ formats: all # 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-requires.txt \ No newline at end of file +python: + install: + - requirements: docs-requires.txt \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index f15aac4..e25122c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,4 +62,4 @@ master_doc = 'index' extlinks = { - 'issue': ('https://github.com/sdabhi23/bsedata/issues/%s', 'issue ')} + 'issue': ('https://github.com/sdabhi23/bsedata/issues/%s', 'issue %s')} From 30f3b54b1b53f655e404b67cc7b53db8909411e0 Mon Sep 17 00:00:00 2001 From: sdabhi23 Date: Tue, 5 Sep 2023 15:36:13 +0530 Subject: [PATCH 6/6] fix docs --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 04b2322..34b4d37 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -23,7 +23,7 @@ sphinx: # fail_on_warning: true # Optionally build your docs in additional formats such as PDF and ePub -formats: all +# formats: all # Optional but recommended, declare the Python requirements required # to build your documentation