Merge pull request #46 from sdabhi23/dev

Fix tests and docs

.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

.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

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

docs-requires.txt

@@ -0,0 +1,7 @@
+sphinxext-opengraph
+sphinx-copybutton
+beautifulsoup4
+requests
+sphinx
+furo
+lxml

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 ---------------------------------------------------
@@ -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')}