mirror of
https://github.com/inventree/InvenTree.git
synced 2025-07-21 20:26:29 +00:00
Render API docs (#6463)
* Render API docs
* Cleanup broken links
* Re-enable strict mode
* Change json to yaml
* Update docs/docs/api/schema.md
Co-authored-by: Matthias Mair <code@mjmair.com>
* Update docs/docs/api/schema.md
Co-authored-by: Matthias Mair <code@mjmair.com>
* Use neoteroi-mkdocs instead
- seems to render more reliably
* Fix SERVERS section for SPECTACTULAR_SETTINGS
* Script for splitting schema into smaller sections
* Generate an index file for the schema pages
* Move schema.md up one directory
* Fix formatting
* Remove tracked file
* Add hook for rebuilding API schema as part of RTD build
* Extract schema as RTD build step
* install invoke
* export env vars
* remove argparse
* Fix order of operations
* Compress env vars
* Remove custom env vars
- Now configured as part of RTD project
* Migrate db
* Revert "remove argparse"
This reverts commit 4665805340
.
* Post-process generated schema file
* Fix file formatting
* Add note about schema repo
* no message
* Reduce schema overhead
* Ignore generated files
* Delete generated file
* Update .gitignore
* Add extra split for machine integration
* Remove schema files
- These will be auto-generated too
* Generate individual schema .md files
* Re-add .md files
- Need git commit log to work
* Update .gitignore
* Fix for CI test
* patch machine.api
* Revert previous change
* Formatting fix
* Adjust export step
* Bump API version
---------
Co-authored-by: Matthias Mair <code@mjmair.com>
This commit is contained in:
7
docs/docs/api/schema/auth.md
Normal file
7
docs/docs/api/schema/auth.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Authorization and Authentication
|
||||
---
|
||||
|
||||
The *Authorization and Authentication* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/auth.yml)]
|
7
docs/docs/api/schema/background-task.md
Normal file
7
docs/docs/api/schema/background-task.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Background Task Management
|
||||
---
|
||||
|
||||
The *Background Task Management* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/background-task.yml)]
|
7
docs/docs/api/schema/barcode.md
Normal file
7
docs/docs/api/schema/barcode.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Barcode Scanning
|
||||
---
|
||||
|
||||
The *Barcode Scanning* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/barcode.yml)]
|
7
docs/docs/api/schema/bom.md
Normal file
7
docs/docs/api/schema/bom.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Bill of Materials
|
||||
---
|
||||
|
||||
The *Bill of Materials* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/bom.yml)]
|
7
docs/docs/api/schema/build.md
Normal file
7
docs/docs/api/schema/build.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Build Order Management
|
||||
---
|
||||
|
||||
The *Build Order Management* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/build.yml)]
|
7
docs/docs/api/schema/company.md
Normal file
7
docs/docs/api/schema/company.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Company Management
|
||||
---
|
||||
|
||||
The *Company Management* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/company.yml)]
|
7
docs/docs/api/schema/general.md
Normal file
7
docs/docs/api/schema/general.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: General API Endpoints
|
||||
---
|
||||
|
||||
The *General API Endpoints* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/general.yml)]
|
7
docs/docs/api/schema/label.md
Normal file
7
docs/docs/api/schema/label.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Label Printing
|
||||
---
|
||||
|
||||
The *Label Printing* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/label.yml)]
|
7
docs/docs/api/schema/machine.md
Normal file
7
docs/docs/api/schema/machine.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: External Machine Management
|
||||
---
|
||||
|
||||
The *External Machine Management* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/machine.yml)]
|
7
docs/docs/api/schema/order.md
Normal file
7
docs/docs/api/schema/order.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: External Order Management
|
||||
---
|
||||
|
||||
The *External Order Management* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/order.yml)]
|
7
docs/docs/api/schema/part.md
Normal file
7
docs/docs/api/schema/part.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Parts and Part Categories
|
||||
---
|
||||
|
||||
The *Parts and Part Categories* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/part.yml)]
|
7
docs/docs/api/schema/plugins.md
Normal file
7
docs/docs/api/schema/plugins.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Plugin Functionality
|
||||
---
|
||||
|
||||
The *Plugin Functionality* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/plugins.yml)]
|
7
docs/docs/api/schema/report.md
Normal file
7
docs/docs/api/schema/report.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Report Generation
|
||||
---
|
||||
|
||||
The *Report Generation* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/report.yml)]
|
7
docs/docs/api/schema/settings.md
Normal file
7
docs/docs/api/schema/settings.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Settings Management
|
||||
---
|
||||
|
||||
The *Settings Management* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/settings.yml)]
|
7
docs/docs/api/schema/stock.md
Normal file
7
docs/docs/api/schema/stock.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Stock and Stock Locations
|
||||
---
|
||||
|
||||
The *Stock and Stock Locations* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/stock.yml)]
|
7
docs/docs/api/schema/user.md
Normal file
7
docs/docs/api/schema/user.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: User Management
|
||||
---
|
||||
|
||||
The *User Management* section of the InvenTree API schema is documented below.
|
||||
|
||||
[OAD(./docs/docs/api/schema/user.yml)]
|
Reference in New Issue
Block a user