mirror of
https://github.com/inventree/InvenTree.git
synced 2026-11-18 14:07:41 +00:00
feat(docs): preperation for plugin modeling documentation (#13077)
* update descriptions * add subsections * another section * keep nultin seperate * rename * make readme easier to copy * add a seperate overview section like machines * update generated schema page * add missing key * make initial paragraph more objective * add model doc stump * fix typos * fix caps * adjust readme for easier copy paste * update generate step * remove additional doc item
This commit is contained in:
1 parent
9e78e73a7c
commit
f4f5caae2c
10 files changed
+119
-76
No files matched your search
@@ -80,6 +80,8 @@ def generate_index_file(version: str):
|
||||
title: InvenTree API Schema
|
||||
---
|
||||
|
||||
## InvenTree API Schema
|
||||
|
||||
The InvenTree API is implemented using the [Django REST framework](https://www.django-rest-framework.org).
|
||||
The API schema as documented below is generated using the [drf-spectactular](https://github.com/tfranzel/drf-spectacular/) extension.
|
||||
|
||||
@@ -109,8 +111,6 @@ def generate_index_file(version: str):
|
||||
|
||||
output += '| [General](./schema/general.md) | General API endpoints |\n'
|
||||
|
||||
output += '\n'
|
||||
|
||||
output_file = os.path.join(os.path.dirname(__file__), OUTPUT_DIR, '..', 'schema.md')
|
||||
|
||||
print('Writing index file to:', output_file)
|
||||
|
||||
Reference in new issue
Block a user