Skip to content

Commit

Permalink
Merge pull request #30 from Capstone-Projects-2024-Spring/BP-109-Gene…
Browse files Browse the repository at this point in the history
…rate-rest-of-python-classes-using-Sphinx

added sphinx documentation
  • Loading branch information
MWedee committed Mar 1, 2024
2 parents a4b019f + 1fe9056 commit 343b8ed
Show file tree
Hide file tree
Showing 32 changed files with 4,367 additions and 287 deletions.
20 changes: 20 additions & 0 deletions Makefile
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file added build/doctrees/environment.pickle
Binary file not shown.
Binary file added build/doctrees/index.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions build/html/.buildinfo
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 04dc633b03e662bfbd75b08594c84208
tags: 645f666f9bcd5a90fca523b33c5a78b7
38 changes: 38 additions & 0 deletions build/html/_sources/index.rst.txt
@@ -0,0 +1,38 @@
.. BlastPad documentation master file, created by
sphinx-quickstart on Thu Feb 29 18:21:38 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to BlastPad's documentation!
====================================

.. toctree::
:maxdepth: 2
:caption: Contents:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Classroom
=========
.. automodule:: classroom
:members:

Configuration
=============
.. automodule:: configuration
:members:

Sensor
======
.. automodule:: sensor
:members:

Homescreen Draft
================
.. automodule:: homeScreenDraft
:members:

0 comments on commit 343b8ed

Please sign in to comment.