Mirrored_Repos/InvenTree
1
0
Fork 0
mirror of https://github.com/inventree/InvenTree synced 2024-08-30 18:33:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
89c7f72caf
InvenTree/docs/index.rst
Oliver Walters d953f1a31e Remove some docs pages 
- These are now being consolidated on the inventree.github.io page
2020-04-18 14:09:14 +10:00

1.5 KiB
Raw Blame History

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

InvenTree Source Documentation

System Message: ERROR/3 (<stdin>, line 4)

Unknown directive type "toctree".

.. toctree::
   :titlesonly:
   :maxdepth: 2
   :caption: Index
   :hidden:

   Translations<translate>
   Modal Forms<forms>
   Tables<tables>
   REST API<rest>
   InvenTree Modules <modules>
   Module Reference<reference>

The documentation found here is provided to be useful for developers working on the InvenTree codebase. User documentation can be found on the InvenTree website.

Documentation for the Python modules is auto-generated from the InvenTree codebase.

Code Structure

Backend

InvenTree is developed using the django web framework, a powerful toolkit for making web applications in Python.

The database management code and business logic is written in Python 3. Core functionality is separated into individual modules (or apps using the django nomenclature).

Each app is located in a separate directory under InvenTree. Each app contains python modules named according to the standard django configuration.

Frontend

The web frontend rendered using a mixture of technologies.

Base HTML code is rendered using the django templating language which provides low-level access to the underlying database models.

jQuery is also used to implement front-end logic, and desponse to user input. A REST API is provided to facilitate client-server communication.

</html>