updated

Author: PavanMudigonda

.github/workflows/deploy-netlify.yml

@@ -21,9 +21,16 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: '3.12'
+          cache: pip
+          cache-dependency-path: requirements-docs.txt
 
-      - name: Generate docs
-        run: bash scripts/build_site.sh
+      - name: Install dependencies
+        run: pip install -r requirements-docs.txt
+
+      - name: Generate Sphinx site
+        run: |
+          bash scripts/build_site.sh
+          sphinx-build -b html docs site
 
       - name: Setup Node.js (for Netlify CLI)
         uses: actions/setup-node@v6
@@ -36,15 +43,15 @@ jobs:
       # Deploy preview for Pull Requests
       - name: Deploy preview to Netlify
         if: github.event_name == 'pull_request'
-        run: netlify deploy --dir=docs --message="PR ${{ github.event.number }} - Run ${{ github.run_number }}"
+        run: netlify deploy --dir=site --message="PR ${{ github.event.number }} - Run ${{ github.run_number }}"
         env:
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
           NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
 
       # Deploy to Production for Main branch pushes
       - name: Deploy to Netlify Production
         if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-        run: netlify deploy --prod --dir=docs --message="Deploy Main - Run ${{ github.run_number }}"
+        run: netlify deploy --prod --dir=site --message="Deploy Main - Run ${{ github.run_number }}"
         env:
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
           NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

docs/index.md

@@ -148,3 +148,76 @@ PyCharm IDE: https://www.jetbrains.com/pycharm/
 
 *Copyright Disclaimer*:
 This video is the intellectual property of Bro Code. All rights reserved. No part of this video may be reproduced, distributed, or transmitted in any form or by any means, including but not limited to recording, uploading, or other electronic or mechanical methods, without my written permission, except in the case of brief quotations embodied in critical reviews and certain other noncommercial uses permitted by copyright law.
+
+
+```{toctree}
+:maxdepth: 2
+:caption: Chapters
+:hidden:
+
+1-print
+2-variables
+3-type-casting
+4-user-input
+5-madlibs-game
+6-if-statements
+7-calculator
+8-weight-conversion
+9-temp-conversion
+10-logical-operators
+11-conditional-expressions
+12-string-methods
+13-string-indexing
+14-email-slicer
+15-format
+16-while
+17-interest-calculator
+18-for
+19-nested-loops
+20-timer
+21-lists-sets-tuples
+22-shopping-cart
+23-2d-collections
+24-quiz-game
+25-dictionaries
+26-concession-stand-program
+27-random-numbers
+28-number-guessing-game
+29-rock-paper-scissors-game
+30-dice-roller-program
+31-encryption-program
+32-functions
+33-default-arguments
+34-keyword-arguments
+35-args-kwargs
+36-iterables
+37-membership-operators
+38-list-comprehensions
+39-match-case-statements
+40-modules
+41-scope-resolution
+42-if-name-main
+43-credit-card-validator
+44-banking-program
+45-slot-machine
+46-hangman-game
+47-python-oop
+48-class-variables
+49-inheritance
+50-multiple-inheritance
+51-abstract-classes
+55-aggregation
+56-composition
+57-nested-classes
+63-lambda
+64-sorting
+65-zip
+66-recursion
+71-execution-time
+74-iterators
+75-generators
+76-generator-expressions
+77-data-classes
+92-qr-codes
+93-music-player
+```

netlify.toml

@@ -1,3 +1,6 @@
 [build]
-  command = "bash scripts/build_site.sh"
-  publish = "docs"
+  publish = "site"
+  command = "pip install -r requirements-docs.txt && bash scripts/build_site.sh && sphinx-build -b html docs site"
+
+[build.environment]
+  PYTHON_VERSION = "3.12"

requirements-docs.txt

@@ -0,0 +1,6 @@
+sphinx>=7.4.0
+furo>=2024.8.6
+myst-parser>=3.0.0
+sphinx-copybutton>=0.5.2
+sphinx-design>=0.6.0
+linkify-it-py>=2.0.0

scripts/generate_docs.py

@@ -65,6 +65,7 @@ def main():
     folders.sort(key=lambda x: int(x.split('-')[0]))
 
     chapter_count = 0
+    generated_chapters = []
 
     for folder in folders:
         readme_path = os.path.join(folder, "README.md")
@@ -98,8 +99,25 @@ def main():
             with open(doc_path, 'w', encoding='utf-8') as wf:
                 wf.write(content)
 
+            generated_chapters.append(folder)
             chapter_count += 1
-                
+
+    # 3. Append MyST toctree to index.md for Sphinx navigation
+    toctree_entries = "\n".join(generated_chapters)
+    toctree_block = f"""
+
+```{{toctree}}
+:maxdepth: 2
+:caption: Chapters
+:hidden:
+
+{toctree_entries}
+```
+"""
+    index_path = os.path.join(docs_dir, "index.md")
+    with open(index_path, 'a', encoding='utf-8') as f:
+        f.write(toctree_block)
+
     print(f"Generated docs for Home + {chapter_count} chapters.")
 
 if __name__ == '__main__':