Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added sphinx documentation #30

Merged
merged 2 commits into from Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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: