fvid/docs/source/index.rst

50 lines
935 B
ReStructuredText

.. Fvid documentation master file, created by
sphinx-quickstart on Sat Feb 20 11:43:24 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Fvid's documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
history
howto
Download & Install
==================
The easiest way to get fvid is via PyPi_ with pip_::
$ pip install -U fvid
You can also ``git clone`` the latest code and install from source::
$ python setup.py install
.. _PyPi: https://pypi.org/project/fvid/
.. _pip: https://pypi.org/project/pip/
.. _clone: https://github.com/AlfredoSequeida/fvid.git
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Authors
=======
* Alfredo Sequeida
* Wisketchy Dobrov
* Theelgirl
Pages
=====
* :doc:`/index`
* :doc:`/history`
* :doc:`/howto`