Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added __pycache__/squares.cpython-38.pyc
Binary file not shown.
Binary file added __pycache__/squares.cpython-39.pyc
Binary file not shown.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -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 = .
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)
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: 5055d8ba63c5c1b4f04f2944f5fd6d29
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file added docs/_build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/html/.doctrees/index.doctree
Binary file not shown.
11 changes: 11 additions & 0 deletions docs/_build/html/_sources/content/average-squares-docs.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Average Squares Documentation
=============================

This section contains documentation about the main functionalities
of the Average Squares project.

API Documentation
==================

.. automodule:: squares
:members:
23 changes: 23 additions & 0 deletions docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. Average Squares documentation master file, created by
sphinx-quickstart on Sun Nov 10 23:57:30 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to Average Squares's documentation!
===========================================
This project provides a utility for calculating the weighted average of squares
of numbers, with additional functionality for data conversion.

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

content/average-squares-docs


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

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