Fix Sphinx documentation build with markdown support and remove warnings-as-errors

Author: mojnomiya

.github/workflows/docs.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Build documentation
         run: |
           cd docs
-          sphinx-build -W -b html -d _build/doctrees . _build/html
+          sphinx-build -b html -d _build/doctrees . _build/html
 
       - name: Upload documentation
         uses: actions/upload-artifact@v4

docs/conf.py

@@ -1,25 +1,32 @@
 import os
 import sys
+from typing import List
 
 sys.path.insert(0, os.path.abspath(".."))
 
 project = "Steadfast Courier Python SDK"
-copyright = "2026, Md Mojno Miya"
+copyright = "2024, Md Mojno Miya"
 author = "Md Mojno Miya"
-release = "0.1.0"
+release = "0.2.0"
 
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
+    "myst_parser",
     "sphinx_rtd_theme",
 ]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 html_theme = "sphinx_rtd_theme"
-html_static_path = ["_static"]
+html_static_path: List[str] = []
 
 autodoc_member_order = "bysource"
 autodoc_typehints = "description"
+
+source_suffix = {
+    ".rst": None,
+    ".md": "markdown",
+}

docs/index.rst

@@ -7,19 +7,18 @@ A Python SDK for the Steadfast Courier API that provides easy-to-use interfaces
    :maxdepth: 2
    :caption: Getting Started
 
-   installation
-   authentication
-   Quick Start <STEADFAST_QUICK_START>
+   Installation <installation>
+   Authentication <authentication>
 
 .. toctree::
    :maxdepth: 2
    :caption: User Guide
 
-   order_management
-   order_tracking
-   balance_management
-   return_requests
-   payments
+   Order Management <order_management>
+   Order Tracking <order_tracking>
+   Balance Management <balance_management>
+   Return Requests <return_requests>
+   Payments <payments>
 
 .. toctree::
    :maxdepth: 2
@@ -31,17 +30,9 @@ A Python SDK for the Steadfast Courier API that provides easy-to-use interfaces
    :maxdepth: 2
    :caption: Advanced
 
-   error_handling
+   Error Handling <error_handling>
    Development Guide <steadfast_dev_guide>
 
-.. toctree::
-   :maxdepth: 1
-   :caption: Additional
-
-   Contributing <../CONTRIBUTING>
-   Code of Conduct <../CODE_OF_CONDUCT>
-   Changelog <../CHANGELOG>
-
 Indices and tables
 ==================
 

requirements-dev.txt

@@ -9,3 +9,4 @@ types-requests>=2.28.0
 pre-commit>=3.0
 sphinx>=5.0
 sphinx-rtd-theme>=1.0
+myst-parser>=0.18.0