Add Sphinx documentation, docs Makefile, and documentation URL
This commit is contained in:
33
docs/index.rst
Normal file
33
docs/index.rst
Normal file
@@ -0,0 +1,33 @@
|
||||
easybits
|
||||
========
|
||||
|
||||
This documentation explains how to use the functions provided
|
||||
in the `easybits` package. `easybits` is distributed via pypi,
|
||||
so you can install it using pip or poetry.
|
||||
|
||||
Every file on your computer is just a sequence of bits. Every message
|
||||
that gets sent between computers is just a sequence of bits. Working
|
||||
directly with bits is easy in lower-level languages, but a bit trickier
|
||||
in Python. `easybits` exposes the bit representations of booleans,
|
||||
integers, and text, so that you can see--and manipulate--the bits
|
||||
underneath the values you already know how to use.
|
||||
|
||||
This documentation is organized according to a common pattern: the
|
||||
:ref:`introduction` contains narrative documentation walking you through
|
||||
how to use the system. The :ref:`api` contains a complete description of
|
||||
each function and how to use it. If you're trying to learn what `easybits`
|
||||
can do, start with the :ref:`introduction`. If you're trying to check a
|
||||
detail about how to do it, head to the :ref:`api`.
|
||||
|
||||
`easybits` is part of the `Making With Code` introductory computer science
|
||||
curriculum, with an intended audience of beginners. It is used in the
|
||||
`Encoding lab <https://makingwithcode.org/courses/mwc2/unit2/lab_encoding/>`_.
|
||||
If you are interested in `Making With Code`, or if you found `easybits`
|
||||
helpful, `Dr. Chris Proctor <https://chrisproctor.net>`_ would love to hear
|
||||
from you.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
introduction
|
||||
api
|
||||
Reference in New Issue
Block a user