Set up a documentation tool
- use sphinx to document the developed package - create nox session "docs" to build the docs
This commit is contained in:
parent
0a85e60b51
commit
c07a9ed19f
8 changed files with 608 additions and 2 deletions
25
docs/index.rst
Normal file
25
docs/index.rst
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
lalib - A Python library to study linear algebra
|
||||
================================================
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
license
|
||||
reference
|
||||
|
||||
|
||||
The goal of this package is to provide
|
||||
a library written in pure `Python`_ (incl. the `standard library`_)
|
||||
to learn about linear algebra by reading and writing code.
|
||||
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
Python 3.9 or newer is needed.
|
||||
The package depends only on core Python (incl. the standard library).
|
||||
|
||||
|
||||
.. _standard library: https://docs.python.org/3/library/index.html
|
||||
.. _python: https://docs.python.org/3/
|
||||
Loading…
Add table
Add a link
Reference in a new issue