From 3a43a8ba727c0bb9b33c6e21a44d292668d1aa09 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Sun, 28 Apr 2019 00:57:29 +1000 Subject: [PATCH] Add custom links to app documentation --- docs/index.rst | 14 ++++---------- docs/introduction.rst | 20 +++++++++++++++++--- 2 files changed, 21 insertions(+), 13 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 9130e05d58..114ecaf27b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,18 +1,12 @@ -.. InvenTree documentation master file, created by - sphinx-quickstart on Sat Apr 27 15:45:39 2019. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +InvenTree's Django Documentation +================================ -Welcome to InvenTree's documentation! -===================================== +This documentation is auto-generated from the `InvenTree codebase `_ .. toctree:: + :titlesonly: :maxdepth: 2 :caption: Contents: :hidden: InvenTree - - -* :ref:`genindex` -* :ref:`modindex` \ No newline at end of file diff --git a/docs/introduction.rst b/docs/introduction.rst index a10fe0e5b5..505da5f865 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -1,4 +1,18 @@ -Introduction -============ +InvenTree +========= -This is a test \ No newline at end of file +InvenTree is an open source inventory management system which provides powerful low-level part management and stock tracking functionality. + +The core of the InvenTree software is a Python/Django database backend whi + + +Django Apps +=========== + +The InvenTree Django ecosystem provides the following 'apps' for core functionality: + +* `InvenTree `_ - High level management functions +* `Build `_ - Part build projects +* `Company `_ - Company management (suppliers / customers) +* `Part `_ - Part management +* `Stock `_ - Stock management \ No newline at end of file