Setup sphinx format

brokenfloppydisk · brokenfloppydisk · commit 8bdcea111697 · 2025-03-14T15:01:09.000-07:00
diff --git a/Resources/Best_Practices.md b/Resources/Best_Practices.md
@@ -1,3 +1,5 @@
+# Best Practices
+
 Yes, there is a general structure and set of best practices that programmers follow when developing a game, regardless of the programming language. Game development involves a range of disciplines including design, programming, art, and sound, but from a **programming perspective**, there are key concepts, structures, and steps to follow to ensure maintainability, scalability, and performance.
 
 ### 1. **Game Design Document (GDD)**
diff --git a/Resources/ExecSummary_rubric.md b/Resources/ExecSummary_rubric.md
@@ -1,3 +1,5 @@
+# Executive Summary
+
 ### 4-Point Rubric for Executive Summary of a Digital Product
 
 | **Criteria**                    | **4 - Exemplary**                                                 | **3 - Proficient**                                                | **2 - Basic**                                                     | **1 - Needs Improvement**                                           |
diff --git a/Resources/MarketingProposal.md b/Resources/MarketingProposal.md
@@ -1,3 +1,5 @@
+# Marketing Proposal
+
 ### 4-Point Rubric for Marketing Proposal of a Digital Product
 
 | **Criteria**                    | **4 - Exemplary**                                                 | **3 - Proficient**                                                | **2 - Basic**                                                     | **1 - Needs Improvement**                                           |
diff --git a/Resources/SCRUM_Overview.md b/Resources/SCRUM_Overview.md
@@ -1,4 +1,4 @@
-## SCRUM
+# SCRUM
 
 SCRUM is an Agile framework used to manage complex product development. It emphasizes iterative progress, collaboration, and adaptability. Here's a breakdown of the SCRUM phases, along with documentation that should be created or maintained during each phase:
 
diff --git a/Resources/SCRUM_rubric.md b/Resources/SCRUM_rubric.md
@@ -1,3 +1,5 @@
+# SCRUM Rubric
+
 ### 4-Point Rubric for Daily SCRUM
 
 | **Criteria**                    | **4 - Exemplary**                                                 | **3 - Proficient**                                                | **2 - Basic**                                                     | **1 - Needs Improvement**                                           |
diff --git a/Resources/SDD_Structural-Considerations.md b/Resources/SDD_Structural-Considerations.md
@@ -1,3 +1,5 @@
+# Structural Considerations
+
 When developing a simulation for Virtual Reality (VR) using VR glasses, the structure and considerations differ from traditional 2D or even 
 3D games because VR introduces specific challenges and opportunities. VR simulations require special handling for immersion, real-time performance, 
 input mechanisms, and user comfort. Below are key aspects and recommended structures that programmers should follow when developing VR simulations, 
diff --git a/Unit 1/01_Introduction-to-SDD.md b/Unit 1/01_Introduction-to-SDD.md
@@ -1,3 +1,5 @@
+# Introduction to SDD
+
 Creating a well-structured approach for Software Design and Development ensures that the project is efficient, maintainable, and scalable. Here’s a guideline you can follow for designing and developing software:
 
 ---
@@ -122,4 +124,4 @@ Creating a well-structured approach for Software Design and Development ensures
   - Conduct regular security audits and penetration tests.
   - Follow security best practices like OWASP Top Ten.
 
----
+
diff --git a/Unit 1/03_Software_Development.md b/Unit 1/03_Software_Development.md
@@ -1 +1 @@
-
+# Software Development
diff --git a/Unit 1/04_Testing.md b/Unit 1/04_Testing.md
@@ -1,3 +1,5 @@
+# Testing
+
 ### **Software Release Life Cycle (SRLC)**  
 
 The **Software Release Life Cycle (SRLC)** refers to the stages a software product goes through from initial development to its final release and maintenance. It ensures that software is developed, tested, deployed, and maintained systematically.
@@ -75,7 +77,6 @@ The **Software Release Life Cycle (SRLC)** refers to the stages a software produ
 
 ---
 
----
 ## **Beta Testing Strategies & Tools for Alpha/Beta Testing**
 
 ### **Beta Testing Strategies**
diff --git a/Unit 2/02_Marketing.md b/Unit 2/02_Marketing.md
@@ -1,4 +1,4 @@
-**Instructions to Develop a Marketing Strategy for your Software/Program/App Idea**
+# **Instructions to Develop a Marketing Strategy for your Software/Program/App Idea**
 
 Developing a marketing strategy is a crucial part of successfully launching any software, program, or app. As a team of high school students working on a software project, you’ll need to not only create the app but also ensure people know about it and want to use it. This requires a well-thought-out marketing plan.
 
diff --git a/Unit 2/03_Presentation.md b/Unit 2/03_Presentation.md
@@ -1,5 +1,4 @@
-
-**Instructions for High School Students to Present Their Business Plan, Marketing Plan, and Demonstrate Their Software/App**
+# **Instructions for High School Students to Present Their Business Plan, Marketing Plan, and Demonstrate Their Software/App**
 
 Presenting your business plan, marketing strategy, and the actual demonstration of your software or app to a group of people is an exciting and important part of your project. It’s your chance to showcase all the hard work your team has put into the project. Here are some steps to help you prepare and deliver a successful presentation.
 
diff --git a/_static/temp b/_static/temp
diff --git a/conf.py b/conf.py
@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'SDD'
+copyright = '2025, Jonathan Virak'
+author = 'Jonathan Virak'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['myst_parser'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+suppress_warnings = ["myst.header"]
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Set title (remove "documentation" from name)
+html_title = 'Software Engineering'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+myst_heading_anchors = 3
diff --git a/index.rst b/index.rst
@@ -0,0 +1,74 @@
+Introduction to Software Engineering
+====================================
+
+Software Engineering is more of an encompassing approach to the development of software.  
+For us to understand what we will be doing in this course we need to define Software Design and Development as two independent ideas to creating software.  
+Thus the terms *software design*, *software development*, and *software engineering* will be defined for clarity.  
+For the most part we use *software design*, *software development* and *software engineering* as interchangeable words.  
+They, however, are scaffolded ideas and we will breakdown each one.  
+From there you will understand the purpose and goal of the course. 
+Below are the differences:
+
+1. **Software Design**:
+
+   - **Focus**: Software design refers to the process of defining the architecture, components, interfaces, and data for a software application. It's about planning how the software will be structured and how it will work.
+   
+   - **Activities**: It includes tasks like creating flowcharts, defining algorithms, selecting appropriate design patterns, and creating the overall structure of the software.
+   
+   - **Goal**: The goal of software design is to create a blueprint or a plan for how the software will be built. It ensures that the software's architecture will support scalability, reliability, and maintainability.
+   
+   - **Tools/Concepts**: UML diagrams, design patterns, data structures, and algorithms.
+
+2. **Software Development**:
+   - **Focus**: Software development is the actual process of building the software based on the design. It encompasses the coding, testing, and debugging of the software to create a working product.
+   
+   - **Activities**: Involves writing code, testing features, debugging issues, and integrating different parts of the software.
+   
+   - **Goal**: The goal of software development is to turn a design into a functional software product that works as intended.
+   
+   - **Tools/Concepts**: Programming languages (like Python, Java, C++), Integrated Development Environments (IDEs), version control systems (e.g., Git), and testing frameworks.
+
+3. **Software Engineering**:
+   
+   - **Focus**: Software engineering is a broader discipline that involves applying engineering principles and systematic methods to the development, operation, and maintenance of software.
+   
+   - **Activities**: Software engineering includes software design and development but extends to areas like requirements gathering, project management, quality assurance, deployment, maintenance, and continuous improvement.
+   
+   - **Goal**: The goal of software engineering is to ensure that software is developed efficiently, meets user needs, and is reliable, scalable, and maintainable. It also aims to apply best practices and methodologies to manage complexity and ensure quality.
+   
+   - **Tools/Concepts**: Software development methodologies (Agile, Waterfall, DevOps), project management tools (e.g., JIRA), version control, testing, continuous integration/continuous deployment (CI/CD), and metrics to track performance and success.
+
+Summary:
+--------
+- **Software Design** is about planning and structuring the software.
+- **Software Development** is about building and coding the software based on the design.
+- **Software Engineering** is a holistic approach that includes both design and development, but also incorporates project management, maintenance, and the use of engineering principles to ensure the software is effective, scalable, and sustainable over time.
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Unit 1:
+
+    Introduction to SDD <Unit 1/01_Introduction-to-SDD.md>
+    Research and Analysis <Unit 1/02_Research-and-Analysis.md>
+    Software Development <Unit 1/03_Software_Development.md>
+    Testing <Unit 1/04_Testing.md>
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Unit 2:
+
+    Business Plan <Unit 2/01_Business_Plan.md>
+    Marketing <Unit 2/02_Marketing.md>
+    Presentation <Unit 2/03_Presentation.md>
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Resources
+
+   Best Practices <Resources/Best_Practices.md>
+   Executive Summary Rubric <Resources/ExecSummary_rubric.md>
+   Marketing Proposal <Resources/MarketingProposal.md>
+   SCRUM Overview <Resources/SCRUM_Overview.md>
+   SCRUM Rubric <Resources/SCRUM_rubric.md>
+   SDD Structural Considerations <Resources/SDD_Structural-Considerations.md>

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Best Practices`
	`2`	`+`
`1`	`3`	`Yes, there is a general structure and set of best practices that programmers follow when developing a game, regardless of the programming language. Game development involves a range of disciplines including design, programming, art, and sound, but from a programming perspective, there are key concepts, structures, and steps to follow to ensure maintainability, scalability, and performance.`
`2`	`4`
`3`	`5`	`### 1. Game Design Document (GDD)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Executive Summary`
	`2`	`+`
`1`	`3`	`### 4-Point Rubric for Executive Summary of a Digital Product`
`2`	`4`
`3`	`5`	`\| Criteria \| 4 - Exemplary \| 3 - Proficient \| 2 - Basic \| 1 - Needs Improvement \|`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Marketing Proposal`
	`2`	`+`
`1`	`3`	`### 4-Point Rubric for Marketing Proposal of a Digital Product`
`2`	`4`
`3`	`5`	`\| Criteria \| 4 - Exemplary \| 3 - Proficient \| 2 - Basic \| 1 - Needs Improvement \|`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## SCRUM`
	`1`	`+# SCRUM`
`2`	`2`
`3`	`3`	`SCRUM is an Agile framework used to manage complex product development. It emphasizes iterative progress, collaboration, and adaptability. Here's a breakdown of the SCRUM phases, along with documentation that should be created or maintained during each phase:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# SCRUM Rubric`
	`2`	`+`
`1`	`3`	`### 4-Point Rubric for Daily SCRUM`
`2`	`4`
`3`	`5`	`\| Criteria \| 4 - Exemplary \| 3 - Proficient \| 2 - Basic \| 1 - Needs Improvement \|`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Structural Considerations`
	`2`	`+`
`1`	`3`	`When developing a simulation for Virtual Reality (VR) using VR glasses, the structure and considerations differ from traditional 2D or even`
`2`	`4`	`3D games because VR introduces specific challenges and opportunities. VR simulations require special handling for immersion, real-time performance,`
`3`	`5`	`input mechanisms, and user comfort. Below are key aspects and recommended structures that programmers should follow when developing VR simulations,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Instructions to Develop a Marketing Strategy for your Software/Program/App Idea`
	`1`	`+# Instructions to Develop a Marketing Strategy for your Software/Program/App Idea`
`2`	`2`
`3`	`3`	`Developing a marketing strategy is a crucial part of successfully launching any software, program, or app. As a team of high school students working on a software project, you’ll need to not only create the app but also ensure people know about it and want to use it. This requires a well-thought-out marketing plan.`
`4`	`4`