2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-15 03:25:42 +00:00

Use neoteroi-mkdocs instead

- seems to render more reliably
This commit is contained in:
Oliver Walters
2024-02-11 08:35:57 +11:00
parent 2627917383
commit 45ac4e774f
8 changed files with 34697 additions and 19 deletions

33261
docs/api.yml Normal file

File diff suppressed because it is too large Load Diff

View File

@ -17,6 +17,9 @@ The API is self-documenting, and the documentation is provided alongside any Inv
{% include 'img.html' %}
{% endwith %}
!!! info "Schema Description"
The API schema is also documented in the [API Schema](./schema.md) page.
## Authentication
Users must be authenticated to gain access to the InvenTree API. The API accepts either basic username:password authentication, or token authentication. Token authentication is recommended as it provides much faster API access.

View File

@ -4,6 +4,10 @@ title: 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/) extensions.
## Schama
## Schema File
!!swagger api.yaml!!
-- TODO -- download
## Schama Spcecification
[OAD(./docs/api.yml)]

File diff suppressed because it is too large Load Diff

View File

@ -55,6 +55,7 @@ extra_css:
- stylesheets/bootstrap.css
- stylesheets/splide.min.css
- stylesheets/extra.css
- stylesheets/neoteroi-mkdocs.css
extra_javascript:
- javascripts/extra.js
- javascripts/fontawesome.js
@ -223,7 +224,8 @@ nav:
# Plugins
plugins:
- render_swagger
- neoteroi.mkdocsoad:
use_pymdownx: true
- include-markdown:
opening_tag: "{!"
closing_tag: "!}"
@ -242,6 +244,8 @@ markdown_extensions:
- meta
- pymdownx.details
- pymdownx.highlight
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences:
custom_fences:
- name: mermaid

View File

@ -4,4 +4,4 @@ mkdocs-material>=9.0,<10.0
mkdocs-git-revision-date-localized-plugin>=1.1,<2.0
mkdocs-simple-hooks>=0.1,<1.0
mkdocs-include-markdown-plugin
mkdocs-render-swagger-plugin
neoteroi-mkdocs